diff --git a/profiles/ResourceSchemas.md b/profiles/ResourceSchemas.md index eba0a06a8194..e9a6895efa32 100644 --- a/profiles/ResourceSchemas.md +++ b/profiles/ResourceSchemas.md @@ -1,292 +1,292 @@ -# All Profiles - -> see https://aka.ms/autorest - -``` yaml -batch: - output-folder: c:/work/github/azure-resource-manager-schemas/generated - override-info: - title: $(name) - - azureresourceschema: - note: This generates all the Azure Resource Schemas into the specified folder (merging as it goes) -``` - -## Specifications - -This should include every single REST-API specification for every Azure Resource/Version this repository - -``` yaml -batch: - input-file: - - ../specification/customer-insights/resource-manager/Microsoft.CustomerInsights/2017-01-01/customer-insights.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/account.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/certificate.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/connection.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/connectionType.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/credential.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/definitions.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscCompilationJob.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscConfiguration.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscNode.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscNodeConfiguration.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/hybridRunbookWorkerGroup.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/job.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/jobSchedule.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/module.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/runbook.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/schedule.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/variable.json - - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/webhook.json - - - ../specification/advisor/resource-manager/Microsoft.Advisor/2016-07-12-preview/advisor.json - - ../specification/advisor/resource-manager/Microsoft.Advisor/2017-03-31/advisor.json - - ../specification/advisor/resource-manager/Microsoft.Advisor/2017-04-19/advisor.json - - ../specification/analysisservices/resource-manager/Microsoft.AnalysisServices/2016-05-16/analysisservices.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-07-07/apimanagement.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-07-07/apimdeployment.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimanagement.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimapis.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimauthorizationservers.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimbackends.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimcertificates.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimdeployment.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimgroups.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimidentityprovider.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimloggers.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimnetworkstatus.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimopenidconnectproviders.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimproducts.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimproperties.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimquotas.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimreports.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimsubscriptions.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimtenant.json - - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimusers.json - - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/aiOperations_API.json - - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/components_API.json - - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/webTests_API.json - - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/componentContinuousExport_API.json - - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/componentFeaturesAndPricing_API.json - - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/componentApiKeys_API.json - - ../specification/authorization/resource-manager/Microsoft.Authorization/2015-07-01/authorization.json - - ../specification/batch/resource-manager/Microsoft.Batch/2015-12-01/BatchManagement.json - - ../specification/batch/resource-manager/Microsoft.Batch/2017-01-01/BatchManagement.json - - ../specification/batch/resource-manager/Microsoft.Batch/2017-05-01/BatchManagement.json - - ../specification/billing/resource-manager/Microsoft.Billing/2017-02-27-preview/billing.json - - ../specification/billing/resource-manager/Microsoft.Billing/2017-04-24-preview/billing.json - - ../specification/cdn/resource-manager/Microsoft.Cdn/2015-06-01/cdn.json - - ../specification/cdn/resource-manager/Microsoft.Cdn/2016-04-02/cdn.json - - ../specification/cdn/resource-manager/Microsoft.Cdn/2016-10-02/cdn.json - - ../specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/2016-02-01-preview/cognitiveservices.json - - ../specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/2017-04-18/cognitiveservices.json - - ../specification/commerce/resource-manager/Microsoft.Commerce/2015-06-01-preview/commerce.json - - ../specification/compute/resource-manager/Microsoft.Compute/2015-06-15/compute.json - - ../specification/compute/resource-manager/Microsoft.Compute/2016-03-30/compute.json - - ../specification/compute/resource-manager/Microsoft.Compute/2016-04-30-preview/compute.json - - ../specification/compute/resource-manager/Microsoft.Compute/2016-04-30-preview/disk.json - - ../specification/compute/resource-manager/Microsoft.ContainerService/2015-11-01-preview/containerService.json - - ../specification/compute/resource-manager/Microsoft.ContainerService/2016-03-30/containerService.json - - ../specification/compute/resource-manager/Microsoft.ContainerService/2016-09-30/containerService.json - - ../specification/compute/resource-manager/Microsoft.ContainerService/2017-01-31/containerService.json - - ../specification/consumption/resource-manager/Microsoft.Consumption/2017-04-24-preview/consumption.json - - ../specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/2016-06-27-preview/containerregistry.json - - ../specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/2017-03-01/containerregistry.json - - ../specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/2017-06-01-preview/containerregistry.json - - - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2015-10-01-preview/account.json - - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2015-10-01-preview/catalog.json - - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2015-11-01-preview/job.json - - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-03-20-preview/job.json - - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json - - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/catalog.json - - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/job.json - - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2015-10-01-preview/account.json - - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2015-10-01-preview/filesystem.json - - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json - - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/filesystem.json - - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2017-11-15-preview/datamigration.json - - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-03-15-preview/datamigration.json - - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-03-31-preview/datamigration.json - - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-04-19/datamigration.json - - ../specification/devtestlabs/resource-manager/Microsoft.DevTestLab/2015-05-21-preview/DTL.json - - ../specification/devtestlabs/resource-manager/Microsoft.DevTestLab/2016-05-15/DTL.json - - ../specification/dns/resource-manager/Microsoft.Network/2015-05-04-preview/dns.json - - ../specification/dns/resource-manager/Microsoft.Network/2016-04-01/dns.json - - ../specification/documentdb/resource-manager/Microsoft.DocumentDB/2015-04-08/documentdb.json - - ../specification/eventhub/resource-manager/Microsoft.EventHub/2015-08-01/EventHub.json - - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/applications.json - - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/capabilities.json - - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/cluster.json - - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/configurations.json - - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/extensions.json - - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/operations.json - - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/scriptActions.json - - ../specification/insights/resource-manager/microsoft.insights/2014-04-01/insightsClient_UsageMetrics.json - - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsClient_EventCategories.json - - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsClient_Events.json - - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsClient_TenantEvents.json - - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsManagementClient_Autoscale.json - - ../specification/insights/resource-manager/microsoft.insights/2015-07-01/insightsManagementClient_DiagnosticsSettings.json - - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsClient_MetricDefinitions.json - - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsManagementClient_AlertRules.json - - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsManagementClient_AlertRulesIncidents.json - - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsManagementClient_LogProfiles.json - - ../specification/insights/resource-manager/microsoft.insights/2016-09-01/insightsClient_Metrics.json - - ../specification/intune/resource-manager/Microsoft.Intune/2015-01-14-preview/intune.json - - ../specification/intune/resource-manager/Microsoft.Intune/2015-01-14-privatepreview/intune.json - - ../specification/iothub/resource-manager/Microsoft.Devices/2016-02-03/iothub.json - - ../specification/iothub/resource-manager/Microsoft.Devices/2017-01-19/iothub.json - - ../specification/keyvault/resource-manager/Microsoft.KeyVault/2015-06-01/keyvault.json - - ../specification/logic/resource-manager/Microsoft.Logic/2015-02-01-preview/logic.json - - ../specification/logic/resource-manager/Microsoft.Logic/2015-08-01-preview/logic.json - - ../specification/logic/resource-manager/Microsoft.Logic/2016-06-01/logic.json - - ../specification/machinelearning/resource-manager/Microsoft.MachineLearning/2016-05-01-preview/commitmentPlans.json - - ../specification/machinelearning/resource-manager/Microsoft.MachineLearning/2016-05-01-preview/webservices.json - - ../specification/machinelearning/resource-manager/Microsoft.MachineLearning/2017-01-01/webservices.json - - ../specification/mediaservices/resource-manager/Microsoft.Media/2015-10-01/media.json - - ../specification/mobileengagement/resource-manager/Microsoft.MobileEngagement/2014-12-01/mobile-engagement.json - - ../specification/monitor/resource-manager/microsoft.insights/2015-04-01/autoscale_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2015-07-01/serviceDiagnosticsSettings_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2016-03-01/alertRulesIncidents_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2016-03-01/alertRules_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2016-03-01/logProfiles_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2016-09-01/serviceDiagnosticsSettings_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2017-03-01-preview/activityLogAlerts_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2017-04-01/actionGroups_API.json - - ../specification/monitor/resource-manager/microsoft.insights/2017-04-01/activityLogAlerts_API.json - - ../specification/network/resource-manager/microsoft.Compute/2016-09-01/vmssNetworkInterface.json - - ../specification/network/resource-manager/microsoft.Compute/2016-12-01/vmssNetworkInterface.json - - ../specification/network/resource-manager/microsoft.Compute/2017-03-01/vmssNetworkInterface.json - - ../specification/network/resource-manager/Microsoft.Network/2015-05-01-preview/network.json - - ../specification/network/resource-manager/Microsoft.Network/2015-06-15/network.json - - ../specification/network/resource-manager/Microsoft.Network/2016-03-30/network.json - - ../specification/network/resource-manager/Microsoft.Network/2016-06-01/network.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/applicationGateway.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/checkDnsAvailability.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/expressRouteCircuit.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/loadBalancer.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/network.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/networkInterface.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/networkSecurityGroup.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/networkWatcher.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/publicIpAddress.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/routeTable.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/usage.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/virtualNetwork.json - - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/virtualNetworkGateway.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/applicationGateway.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/checkDnsAvailability.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/expressRouteCircuit.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/loadBalancer.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/network.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/networkInterface.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/networkSecurityGroup.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/networkWatcher.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/publicIpAddress.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/routeFilter.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/routeTable.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/serviceCommunity.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/usage.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/virtualNetwork.json - - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/virtualNetworkGateway.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/applicationGateway.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/checkDnsAvailability.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/expressRouteCircuit.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/loadBalancer.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/network.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/networkInterface.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/networkSecurityGroup.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/networkWatcher.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/publicIpAddress.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/routeFilter.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/routeTable.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/serviceCommunity.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/usage.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/virtualNetwork.json - - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/virtualNetworkGateway.json - - ../specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/2014-09-01/notificationhubs.json - - ../specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/2016-03-01/notificationhubs.json - - ../specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/2017-04-01/notificationhubs.json - - ../specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/2015-03-20/OperationalInsights.json - - ../specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/2015-11-01-preview/OperationalInsights.json - - ../specification/powerbiembedded/resource-manager/Microsoft.PowerBI/2016-01-29/powerbiembedded.json - - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/registeredidentities.json - - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/replicationusages.json - - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/vaults.json - - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/vaultusages.json - - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-12-01/backup.json - - ../specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/2016-06-01/recoveryservicesbackup.json - - ../specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/2016-06-01/registeredIdentities.json - - ../specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/2016-12-01/backupManagement.json - - ../specification/redis/resource-manager/Microsoft.Cache/2015-08-01/redis.json - - ../specification/redis/resource-manager/Microsoft.Cache/2016-04-01/redis.json - - ../specification/relay/resource-manager/Microsoft.Relay/2016-07-01/relay.json - - ../specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/2015-01-01/resourcehealth.json - - ../specification/resources/resource-manager/Microsoft.Authorization/2015-01-01/locks.json - - ../specification/resources/resource-manager/Microsoft.Authorization/2015-10-01-preview/policy.json - - ../specification/resources/resource-manager/Microsoft.Authorization/2016-04-01/policy.json - - ../specification/resources/resource-manager/Microsoft.Authorization/2016-09-01/locks.json - - ../specification/resources/resource-manager/Microsoft.Authorization/2016-12-01/policy.json - - ../specification/resources/resource-manager/Microsoft.Features/2015-12-01/features.json - - ../specification/resources/resource-manager/Microsoft.Resources/2015-11-01/resources.json - - ../specification/resources/resource-manager/Microsoft.Resources/2015-11-01/subscriptions.json - - ../specification/resources/resource-manager/Microsoft.Resources/2016-02-01/resources.json - - ../specification/resources/resource-manager/Microsoft.Resources/2016-06-01/subscriptions.json - - ../specification/resources/resource-manager/Microsoft.Resources/2016-07-01/resources.json - - ../specification/resources/resource-manager/Microsoft.Resources/2016-09-01/links.json - - ../specification/resources/resource-manager/Microsoft.Resources/2016-09-01/resources.json - - ../specification/resources/resource-manager/Microsoft.Resources/2017-05-10/resources.json - - ../specification/resources/resource-manager/Microsoft.Solutions/2016-09-01-preview/managedapplications.json - - ../specification/scheduler/resource-manager/Microsoft.Scheduler/2014-08-01-preview/scheduler.json - - ../specification/scheduler/resource-manager/Microsoft.Scheduler/2016-01-01/scheduler.json - - ../specification/scheduler/resource-manager/Microsoft.Scheduler/2016-03-01/scheduler.json - - ../specification/search/resource-manager/Microsoft.Search/2015-02-28/search.json - - ../specification/search/resource-manager/Microsoft.Search/2015-08-19/search.json - - ../specification/serialconsole/resource-manager/Microsoft.SerialConsole/2018-05-01/serialconsole.json - - ../specification/servermanagement/resource-manager/Microsoft.ServerManagement/2015-07-01-preview/servermanagement.json - - ../specification/servermanagement/resource-manager/Microsoft.ServerManagement/2016-07-01-preview/servermanagement.json - - ../specification/service-map/resource-manager/Microsoft.OperationalInsights/2015-11-01-preview/arm-service-map.json - - ../specification/servicebus/resource-manager/Microsoft.ServiceBus/2015-08-01/servicebus.json - - ../specification/servicefabric/resource-manager/Microsoft.ServiceFabric/2016-09-01/servicefabric.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/backups.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/capabilities.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/databaseSecurityAlertPolicies.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/firewallRules.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/importExport.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/operations.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/replicationLinks.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/serverAzureADAdministrators.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/servers.json - - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/sql.core.json - - ../specification/sql/resource-manager/Microsoft.Sql/2015-05-01-preview/blobAuditingPolicies.json - - ../specification/sql/resource-manager/Microsoft.Sql/2015-05-01-preview/failoverGroups.json - - ../specification/sql/resource-manager/Microsoft.Sql/2015-05-01-preview/virtualNetworkRules.json - - ../specification/storage/resource-manager/Microsoft.Storage/2015-05-01-preview/storage.json - - ../specification/storage/resource-manager/Microsoft.Storage/2015-06-15/storage.json - - ../specification/storage/resource-manager/Microsoft.Storage/2016-01-01/storage.json - - ../specification/storage/resource-manager/Microsoft.Storage/2016-05-01/storage.json - - ../specification/storage/resource-manager/Microsoft.Storage/2016-12-01/storage.json - - ../specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/storageimportexport.json - - ../specification/storsimple8000series/resource-manager/Microsoft.StorSimple/2017-06-01/storsimple.json - - - ../specification/trafficmanager/resource-manager/Microsoft.Network/2015-11-01/trafficmanager.json - - ../specification/trafficmanager/resource-manager/Microsoft.Network/2017-03-01/trafficmanager.json - - ../specification/web/resource-manager/Microsoft.CertificateRegistration/2015-08-01/AppServiceCertificateOrders.json - - ../specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/Domains.json - - ../specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/TopLevelDomains.json - - ../specification/web/resource-manager/Microsoft.Web/2015-08-01/service.json - - ../specification/web/resource-manager/Microsoft.Web/2015-08-01-preview/logicAppsManagementClient.json - - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/Certificates.json - - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/DeletedWebApps.json - - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/Provider.json - - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/Recommendations.json - - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/ResourceProvider.json - - ../specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json - - ../specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServiceEnvironments.json - - ../specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServicePlans.json - - ../specification/kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/kusto.json - - # some invalid swagger - # - ../specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/2017-02-28-preview/timeseriesinsights.json +# All Profiles + +> see https://aka.ms/autorest + +``` yaml +batch: + output-folder: c:/work/github/azure-resource-manager-schemas/generated + override-info: + title: $(name) + + azureresourceschema: + note: This generates all the Azure Resource Schemas into the specified folder (merging as it goes) +``` + +## Specifications + +This should include every single REST-API specification for every Azure Resource/Version this repository + +``` yaml +batch: + input-file: + - ../specification/customer-insights/resource-manager/Microsoft.CustomerInsights/2017-01-01/customer-insights.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/account.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/certificate.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/connection.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/connectionType.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/credential.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/definitions.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscCompilationJob.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscConfiguration.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscNode.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/dscNodeConfiguration.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/hybridRunbookWorkerGroup.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/job.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/jobSchedule.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/module.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/runbook.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/schedule.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/variable.json + - ../specification/automation/resource-manager/Microsoft.Automation/2015-10-31/webhook.json + + - ../specification/advisor/resource-manager/Microsoft.Advisor/2016-07-12-preview/advisor.json + - ../specification/advisor/resource-manager/Microsoft.Advisor/2017-03-31/advisor.json + - ../specification/advisor/resource-manager/Microsoft.Advisor/2017-04-19/advisor.json + - ../specification/analysisservices/resource-manager/Microsoft.AnalysisServices/2016-05-16/analysisservices.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-07-07/apimanagement.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-07-07/apimdeployment.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimanagement.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimapis.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimauthorizationservers.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimbackends.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimcertificates.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimdeployment.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimgroups.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimidentityprovider.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimloggers.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimnetworkstatus.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimopenidconnectproviders.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimproducts.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimproperties.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimquotas.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimreports.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimsubscriptions.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimtenant.json + - ../specification/apimanagement/resource-manager/Microsoft.ApiManagement/2016-10-10/apimusers.json + - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/aiOperations_API.json + - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/components_API.json + - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/webTests_API.json + - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/componentContinuousExport_API.json + - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/componentFeaturesAndPricing_API.json + - ../specification/applicationinsights/resource-manager/microsoft.insights/2015-05-01/componentApiKeys_API.json + - ../specification/authorization/resource-manager/Microsoft.Authorization/2015-07-01/authorization.json + - ../specification/batch/resource-manager/Microsoft.Batch/2015-12-01/BatchManagement.json + - ../specification/batch/resource-manager/Microsoft.Batch/2017-01-01/BatchManagement.json + - ../specification/batch/resource-manager/Microsoft.Batch/2017-05-01/BatchManagement.json + - ../specification/billing/resource-manager/Microsoft.Billing/2017-02-27-preview/billing.json + - ../specification/billing/resource-manager/Microsoft.Billing/2017-04-24-preview/billing.json + - ../specification/cdn/resource-manager/Microsoft.Cdn/2015-06-01/cdn.json + - ../specification/cdn/resource-manager/Microsoft.Cdn/2016-04-02/cdn.json + - ../specification/cdn/resource-manager/Microsoft.Cdn/2016-10-02/cdn.json + - ../specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/2016-02-01-preview/cognitiveservices.json + - ../specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/2017-04-18/cognitiveservices.json + - ../specification/commerce/resource-manager/Microsoft.Commerce/2015-06-01-preview/commerce.json + - ../specification/compute/resource-manager/Microsoft.Compute/2015-06-15/compute.json + - ../specification/compute/resource-manager/Microsoft.Compute/2016-03-30/compute.json + - ../specification/compute/resource-manager/Microsoft.Compute/2016-04-30-preview/compute.json + - ../specification/compute/resource-manager/Microsoft.Compute/2016-04-30-preview/disk.json + - ../specification/compute/resource-manager/Microsoft.ContainerService/2015-11-01-preview/containerService.json + - ../specification/compute/resource-manager/Microsoft.ContainerService/2016-03-30/containerService.json + - ../specification/compute/resource-manager/Microsoft.ContainerService/2016-09-30/containerService.json + - ../specification/compute/resource-manager/Microsoft.ContainerService/2017-01-31/containerService.json + - ../specification/consumption/resource-manager/Microsoft.Consumption/2017-04-24-preview/consumption.json + - ../specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/2016-06-27-preview/containerregistry.json + - ../specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/2017-03-01/containerregistry.json + - ../specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/2017-06-01-preview/containerregistry.json + + - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2015-10-01-preview/account.json + - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2015-10-01-preview/catalog.json + - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2015-11-01-preview/job.json + - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-03-20-preview/job.json + - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/account.json + - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/catalog.json + - ../specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/2016-11-01/job.json + - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2015-10-01-preview/account.json + - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2015-10-01-preview/filesystem.json + - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/account.json + - ../specification/datalake-store/resource-manager/Microsoft.DataLakeStore/2016-11-01/filesystem.json + - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2017-11-15-preview/datamigration.json + - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-03-15-preview/datamigration.json + - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-03-31-preview/datamigration.json + - ../specification/datamigration/resource-manager/Microsoft.DataMigration/2018-04-19/datamigration.json + - ../specification/devtestlabs/resource-manager/Microsoft.DevTestLab/2015-05-21-preview/DTL.json + - ../specification/devtestlabs/resource-manager/Microsoft.DevTestLab/2016-05-15/DTL.json + - ../specification/dns/resource-manager/Microsoft.Network/2015-05-04-preview/dns.json + - ../specification/dns/resource-manager/Microsoft.Network/2016-04-01/dns.json + - ../specification/documentdb/resource-manager/Microsoft.DocumentDB/2015-04-08/documentdb.json + - ../specification/eventhub/resource-manager/Microsoft.EventHub/2015-08-01/EventHub.json + - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/applications.json + - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/capabilities.json + - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/cluster.json + - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/configurations.json + - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/extensions.json + - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/operations.json + - ../specification/hdinsight/resource-manager/Microsoft.HDInsight/2015-03-01-preview/scriptActions.json + - ../specification/insights/resource-manager/microsoft.insights/2014-04-01/insightsClient_UsageMetrics.json + - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsClient_EventCategories.json + - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsClient_Events.json + - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsClient_TenantEvents.json + - ../specification/insights/resource-manager/microsoft.insights/2015-04-01/insightsManagementClient_Autoscale.json + - ../specification/insights/resource-manager/microsoft.insights/2015-07-01/insightsManagementClient_DiagnosticsSettings.json + - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsClient_MetricDefinitions.json + - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsManagementClient_AlertRules.json + - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsManagementClient_AlertRulesIncidents.json + - ../specification/insights/resource-manager/microsoft.insights/2016-03-01/insightsManagementClient_LogProfiles.json + - ../specification/insights/resource-manager/microsoft.insights/2016-09-01/insightsClient_Metrics.json + - ../specification/intune/resource-manager/Microsoft.Intune/2015-01-14-preview/intune.json + - ../specification/intune/resource-manager/Microsoft.Intune/2015-01-14-privatepreview/intune.json + - ../specification/iothub/resource-manager/Microsoft.Devices/2016-02-03/iothub.json + - ../specification/iothub/resource-manager/Microsoft.Devices/2017-01-19/iothub.json + - ../specification/keyvault/resource-manager/Microsoft.KeyVault/2015-06-01/keyvault.json + - ../specification/logic/resource-manager/Microsoft.Logic/2015-02-01-preview/logic.json + - ../specification/logic/resource-manager/Microsoft.Logic/2015-08-01-preview/logic.json + - ../specification/logic/resource-manager/Microsoft.Logic/2016-06-01/logic.json + - ../specification/machinelearning/resource-manager/Microsoft.MachineLearning/2016-05-01-preview/commitmentPlans.json + - ../specification/machinelearning/resource-manager/Microsoft.MachineLearning/2016-05-01-preview/webservices.json + - ../specification/machinelearning/resource-manager/Microsoft.MachineLearning/2017-01-01/webservices.json + - ../specification/mediaservices/resource-manager/Microsoft.Media/2015-10-01/media.json + - ../specification/mobileengagement/resource-manager/Microsoft.MobileEngagement/2014-12-01/mobile-engagement.json + - ../specification/monitor/resource-manager/microsoft.insights/2015-04-01/autoscale_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2015-07-01/serviceDiagnosticsSettings_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2016-03-01/alertRulesIncidents_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2016-03-01/alertRules_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2016-03-01/logProfiles_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2016-09-01/serviceDiagnosticsSettings_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2017-03-01-preview/activityLogAlerts_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2017-04-01/actionGroups_API.json + - ../specification/monitor/resource-manager/microsoft.insights/2017-04-01/activityLogAlerts_API.json + - ../specification/network/resource-manager/microsoft.Compute/2016-09-01/vmssNetworkInterface.json + - ../specification/network/resource-manager/microsoft.Compute/2016-12-01/vmssNetworkInterface.json + - ../specification/network/resource-manager/microsoft.Compute/2017-03-01/vmssNetworkInterface.json + - ../specification/network/resource-manager/Microsoft.Network/2015-05-01-preview/network.json + - ../specification/network/resource-manager/Microsoft.Network/2015-06-15/network.json + - ../specification/network/resource-manager/Microsoft.Network/2016-03-30/network.json + - ../specification/network/resource-manager/Microsoft.Network/2016-06-01/network.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/applicationGateway.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/checkDnsAvailability.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/expressRouteCircuit.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/loadBalancer.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/network.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/networkInterface.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/networkSecurityGroup.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/networkWatcher.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/publicIpAddress.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/routeTable.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/usage.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/virtualNetwork.json + - ../specification/network/resource-manager/Microsoft.Network/2016-09-01/virtualNetworkGateway.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/applicationGateway.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/checkDnsAvailability.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/expressRouteCircuit.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/loadBalancer.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/network.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/networkInterface.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/networkSecurityGroup.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/networkWatcher.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/publicIpAddress.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/routeFilter.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/routeTable.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/serviceCommunity.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/usage.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/virtualNetwork.json + - ../specification/network/resource-manager/Microsoft.Network/2016-12-01/virtualNetworkGateway.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/applicationGateway.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/checkDnsAvailability.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/expressRouteCircuit.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/loadBalancer.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/network.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/networkInterface.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/networkSecurityGroup.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/networkWatcher.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/publicIpAddress.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/routeFilter.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/routeTable.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/serviceCommunity.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/usage.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/virtualNetwork.json + - ../specification/network/resource-manager/Microsoft.Network/2017-03-01/virtualNetworkGateway.json + - ../specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/2014-09-01/notificationhubs.json + - ../specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/2016-03-01/notificationhubs.json + - ../specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/2017-04-01/notificationhubs.json + - ../specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/2015-03-20/OperationalInsights.json + - ../specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/2015-11-01-preview/OperationalInsights.json + - ../specification/powerbiembedded/resource-manager/Microsoft.PowerBI/2016-01-29/powerbiembedded.json + - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/registeredidentities.json + - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/replicationusages.json + - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/vaults.json + - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-06-01/vaultusages.json + - ../specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/2016-12-01/backup.json + - ../specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/2016-06-01/recoveryservicesbackup.json + - ../specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/2016-06-01/registeredIdentities.json + - ../specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/2016-12-01/backupManagement.json + - ../specification/redis/resource-manager/Microsoft.Cache/2015-08-01/redis.json + - ../specification/redis/resource-manager/Microsoft.Cache/2016-04-01/redis.json + - ../specification/relay/resource-manager/Microsoft.Relay/2016-07-01/relay.json + - ../specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/2015-01-01/resourcehealth.json + - ../specification/resources/resource-manager/Microsoft.Authorization/2015-01-01/locks.json + - ../specification/resources/resource-manager/Microsoft.Authorization/2015-10-01-preview/policy.json + - ../specification/resources/resource-manager/Microsoft.Authorization/2016-04-01/policy.json + - ../specification/resources/resource-manager/Microsoft.Authorization/2016-09-01/locks.json + - ../specification/resources/resource-manager/Microsoft.Authorization/2016-12-01/policy.json + - ../specification/resources/resource-manager/Microsoft.Features/2015-12-01/features.json + - ../specification/resources/resource-manager/Microsoft.Resources/2015-11-01/resources.json + - ../specification/resources/resource-manager/Microsoft.Resources/2015-11-01/subscriptions.json + - ../specification/resources/resource-manager/Microsoft.Resources/2016-02-01/resources.json + - ../specification/resources/resource-manager/Microsoft.Resources/2016-06-01/subscriptions.json + - ../specification/resources/resource-manager/Microsoft.Resources/2016-07-01/resources.json + - ../specification/resources/resource-manager/Microsoft.Resources/2016-09-01/links.json + - ../specification/resources/resource-manager/Microsoft.Resources/2016-09-01/resources.json + - ../specification/resources/resource-manager/Microsoft.Resources/2017-05-10/resources.json + - ../specification/resources/resource-manager/Microsoft.Solutions/2016-09-01-preview/managedapplications.json + - ../specification/scheduler/resource-manager/Microsoft.Scheduler/2014-08-01-preview/scheduler.json + - ../specification/scheduler/resource-manager/Microsoft.Scheduler/2016-01-01/scheduler.json + - ../specification/scheduler/resource-manager/Microsoft.Scheduler/2016-03-01/scheduler.json + - ../specification/search/resource-manager/Microsoft.Search/2015-02-28/search.json + - ../specification/search/resource-manager/Microsoft.Search/2015-08-19/search.json + - ../specification/serialconsole/resource-manager/Microsoft.SerialConsole/2018-05-01/serialconsole.json + - ../specification/servermanagement/resource-manager/Microsoft.ServerManagement/2015-07-01-preview/servermanagement.json + - ../specification/servermanagement/resource-manager/Microsoft.ServerManagement/2016-07-01-preview/servermanagement.json + - ../specification/service-map/resource-manager/Microsoft.OperationalInsights/2015-11-01-preview/arm-service-map.json + - ../specification/servicebus/resource-manager/Microsoft.ServiceBus/2015-08-01/servicebus.json + - ../specification/servicefabric/resource-manager/Microsoft.ServiceFabric/2016-09-01/servicefabric.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/backups.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/capabilities.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/databaseSecurityAlertPolicies.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/firewallRules.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/importExport.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/operations.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/replicationLinks.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/serverAzureADAdministrators.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/servers.json + - ../specification/sql/resource-manager/Microsoft.Sql/2014-04-01/sql.core.json + - ../specification/sql/resource-manager/Microsoft.Sql/2015-05-01-preview/blobAuditingPolicies.json + - ../specification/sql/resource-manager/Microsoft.Sql/2015-05-01-preview/failoverGroups.json + - ../specification/sql/resource-manager/Microsoft.Sql/2015-05-01-preview/virtualNetworkRules.json + - ../specification/storage/resource-manager/Microsoft.Storage/2015-05-01-preview/storage.json + - ../specification/storage/resource-manager/Microsoft.Storage/2015-06-15/storage.json + - ../specification/storage/resource-manager/Microsoft.Storage/2016-01-01/storage.json + - ../specification/storage/resource-manager/Microsoft.Storage/2016-05-01/storage.json + - ../specification/storage/resource-manager/Microsoft.Storage/2016-12-01/storage.json + - ../specification/storageimportexport/resource-manager/Microsoft.ImportExport/2016-11-01/storageimportexport.json + - ../specification/storsimple8000series/resource-manager/Microsoft.StorSimple/2017-06-01/storsimple.json + + - ../specification/trafficmanager/resource-manager/Microsoft.Network/2015-11-01/trafficmanager.json + - ../specification/trafficmanager/resource-manager/Microsoft.Network/2017-03-01/trafficmanager.json + - ../specification/web/resource-manager/Microsoft.CertificateRegistration/2015-08-01/AppServiceCertificateOrders.json + - ../specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/Domains.json + - ../specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/TopLevelDomains.json + - ../specification/web/resource-manager/Microsoft.Web/2015-08-01/service.json + - ../specification/web/resource-manager/Microsoft.Web/2015-08-01-preview/logicAppsManagementClient.json + - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/Certificates.json + - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/DeletedWebApps.json + - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/Provider.json + - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/Recommendations.json + - ../specification/web/resource-manager/Microsoft.Web/2016-03-01/ResourceProvider.json + - ../specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json + - ../specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServiceEnvironments.json + - ../specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServicePlans.json + - ../specification/kusto/resource-manager/Microsoft.Kusto/2017-09-07-privatepreview/kusto.json + + # some invalid swagger + # - ../specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/2017-02-28-preview/timeseriesinsights.json ``` \ No newline at end of file diff --git a/specification/adhybridhealthservice/resource-manager/readme.go.md b/specification/adhybridhealthservice/resource-manager/readme.go.md index 557f9c2eb641..819cef80d451 100644 --- a/specification/adhybridhealthservice/resource-manager/readme.go.md +++ b/specification/adhybridhealthservice/resource-manager/readme.go.md @@ -1,26 +1,26 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: adhybridhealthservice - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2014-01 -``` - -### Tag: package-2014-01 and go - -These settings apply only when `--tag=package-2014-01 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2014-01' && $(go) -output-folder: $(go-sdk-folder)/services/adhybridhealthservice/mgmt/2014-01-01/adhybridhealthservice -``` +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: adhybridhealthservice + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2014-01 +``` + +### Tag: package-2014-01 and go + +These settings apply only when `--tag=package-2014-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2014-01' && $(go) +output-folder: $(go-sdk-folder)/services/adhybridhealthservice/mgmt/2014-01-01/adhybridhealthservice +``` diff --git a/specification/adhybridhealthservice/resource-manager/readme.md b/specification/adhybridhealthservice/resource-manager/readme.md index 3a4a6b7f437b..a12bc816d247 100644 --- a/specification/adhybridhealthservice/resource-manager/readme.md +++ b/specification/adhybridhealthservice/resource-manager/readme.md @@ -1,112 +1,112 @@ -# ADHybridHealthService - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for ADHybridHealthService. - - - ---- -## Getting Started -To build the SDK for ADHybridHealthService, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the ADHybridHealthService API. - -``` yaml -openapi-type: arm -tag: package-2014-01 -``` - - -### Tag: package-2014-01 - -These settings apply only when `--tag=package-2014-01` is specified on the command line. - -``` yaml $(tag) == 'package-2014-01' -input-file: -- Microsoft.ADHybridHealthService\stable\2014-01-01\ADHybridHealthService.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.adhybridhealthservice - package-name: azure-mgmt-adhybridhealthservice - package-version: 1.0.1 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-adhybridhealthservice/azure/mgmt/adhybridhealthservice -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-adhybridhealthservice -``` - - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.adhybridhealthservice -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-adhybridhealthservice -directive: - - rename-operation: - from: addsService_getMetrics - to: addsServices_getMetrics - - rename-operation: - from: service_getMetrics - to: services_getMetrics -``` +# ADHybridHealthService + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ADHybridHealthService. + + + +--- +## Getting Started +To build the SDK for ADHybridHealthService, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the ADHybridHealthService API. + +``` yaml +openapi-type: arm +tag: package-2014-01 +``` + + +### Tag: package-2014-01 + +These settings apply only when `--tag=package-2014-01` is specified on the command line. + +``` yaml $(tag) == 'package-2014-01' +input-file: +- Microsoft.ADHybridHealthService\stable\2014-01-01\ADHybridHealthService.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.adhybridhealthservice + package-name: azure-mgmt-adhybridhealthservice + package-version: 1.0.1 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-adhybridhealthservice/azure/mgmt/adhybridhealthservice +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-adhybridhealthservice +``` + + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.adhybridhealthservice +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-adhybridhealthservice +directive: + - rename-operation: + from: addsService_getMetrics + to: addsServices_getMetrics + - rename-operation: + from: service_getMetrics + to: services_getMetrics +``` 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/readme.md b/specification/advisor/resource-manager/readme.md index 8657eed41d99..ac82d7d369ae 100644 --- a/specification/advisor/resource-manager/readme.md +++ b/specification/advisor/resource-manager/readme.md @@ -1,189 +1,189 @@ -# Advisor - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Advisor. - - - ---- -## Getting Started -To build the SDK for Advisor, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Advisor API. - -``` yaml -openapi-type: arm -tag: package-2017-04 -``` - - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.Advisor/stable/2017-04-19/advisor.json -``` - -### Tag: package-2017-03 - -These settings apply only when `--tag=package-2017-03` is specified on the command line. - -``` yaml $(tag) == 'package-2017-03' -input-file: -- Microsoft.Advisor/stable/2017-03-31/advisor.json -``` - -### Tag: package-2016-07-preview - -These settings apply only when `--tag=package-2016-07-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2016-07-preview' -input-file: -- Microsoft.Advisor/preview/2016-07-12-preview/advisor.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.advisor - package-name: azure-mgmt-advisor - package-version: 1.0.1 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-advisor/azure/mgmt/advisor -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-advisor -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - payload-flattening-threshold: 1 - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Advisor - output-folder: $(csharp-sdks-folder)/Advisor/Management.Advisor/Generated - clear-output-folder: true -``` - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.advisor -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-advisor -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-03 - - tag: package-2017-04 - - tag: package-2016-07-preview -``` - -### Tag: package-2017-03 and java - -These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.advisor.v2017_03_31 - output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_03_31 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.advisor.v2017_04_19 - output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_04_19 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-07-preview and java - -These settings apply only when `--tag=package-2016-07-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-07-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.advisor.v2016_07_12_preview - output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2016_07_12_preview -regenerate-manager: true -generate-interface: true -``` - - +# Advisor + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Advisor. + + + +--- +## Getting Started +To build the SDK for Advisor, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Advisor API. + +``` yaml +openapi-type: arm +tag: package-2017-04 +``` + + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.Advisor/stable/2017-04-19/advisor.json +``` + +### Tag: package-2017-03 + +These settings apply only when `--tag=package-2017-03` is specified on the command line. + +``` yaml $(tag) == 'package-2017-03' +input-file: +- Microsoft.Advisor/stable/2017-03-31/advisor.json +``` + +### Tag: package-2016-07-preview + +These settings apply only when `--tag=package-2016-07-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2016-07-preview' +input-file: +- Microsoft.Advisor/preview/2016-07-12-preview/advisor.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.advisor + package-name: azure-mgmt-advisor + package-version: 1.0.1 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-advisor/azure/mgmt/advisor +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-advisor +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + payload-flattening-threshold: 1 + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Advisor + output-folder: $(csharp-sdks-folder)/Advisor/Management.Advisor/Generated + clear-output-folder: true +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.advisor +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-advisor +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-03 + - tag: package-2017-04 + - tag: package-2016-07-preview +``` + +### Tag: package-2017-03 and java + +These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2017_03_31 + output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_03_31 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2017_04_19 + output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2017_04_19 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-07-preview and java + +These settings apply only when `--tag=package-2016-07-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-07-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.advisor.v2016_07_12_preview + output-folder: $(azure-libraries-for-java-folder)/advisor/resource-manager/v2016_07_12_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/analysisservices/resource-manager/readme.md b/specification/analysisservices/resource-manager/readme.md index 236ceadc1aa3..36ce5a274efe 100644 --- a/specification/analysisservices/resource-manager/readme.md +++ b/specification/analysisservices/resource-manager/readme.md @@ -1,183 +1,183 @@ -# AnalysisServices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for AnalysisServices. - - - ---- -## Getting Started -To build the SDK for AnalysisServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the AnalysisServices API. - -``` yaml -openapi-type: arm -tag: package-2017-08 -``` - - -### Tag: package-2017-08 - -These settings apply only when `--tag=package-2017-08` is specified on the command line. - -``` yaml $(tag) == 'package-2017-08' -input-file: -- Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json -``` - -### Tag: package-2017-08-beta - -These settings apply only when `--tag=package-2017-08-beta` is specified on the command line. - -``` yaml $(tag) == 'package-2017-08-beta' -input-file: -- Microsoft.AnalysisServices/preview/2017-08-01-beta/analysisservices.json -``` - -### Tag: package-2017-07 - -These settings apply only when `--tag=package-2017-07` is specified on the command line. - -``` yaml $(tag) == 'package-2017-07' -input-file: -- Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json -``` - -### Tag: package-2016-05 - -These settings apply only when `--tag=package-2016-05` is specified on the command line. - -``` yaml $(tag) == 'package-2016-05' -input-file: -- Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_analysis_services'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Analysis - output-folder: $(csharp-sdks-folder)/AnalysisServices/Management.Analysis/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.analysisservices -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-analysisservices -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-05 - - tag: package-2017-07 - - tag: package-2017-08 - - tag: package-2017-08-beta -``` - -### Tag: package-2016-05 and java - -These settings apply only when `--tag=package-2016-05 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-05' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.analysisservices.v2016_05_16 - output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2016_05_16 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-07 and java - -These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.analysisservices.v2017_07_14 - output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_07_14 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-08 and java - -These settings apply only when `--tag=package-2017-08 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.analysisservices.v2017_08_01 - output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_08_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-08-beta and java - -These settings apply only when `--tag=package-2017-08-beta --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-08-beta' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.analysisservices.v2017_08_01_beta - output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_08_01_beta -regenerate-manager: true -generate-interface: true -``` - - +# AnalysisServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for AnalysisServices. + + + +--- +## Getting Started +To build the SDK for AnalysisServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the AnalysisServices API. + +``` yaml +openapi-type: arm +tag: package-2017-08 +``` + + +### Tag: package-2017-08 + +These settings apply only when `--tag=package-2017-08` is specified on the command line. + +``` yaml $(tag) == 'package-2017-08' +input-file: +- Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json +``` + +### Tag: package-2017-08-beta + +These settings apply only when `--tag=package-2017-08-beta` is specified on the command line. + +``` yaml $(tag) == 'package-2017-08-beta' +input-file: +- Microsoft.AnalysisServices/preview/2017-08-01-beta/analysisservices.json +``` + +### Tag: package-2017-07 + +These settings apply only when `--tag=package-2017-07` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07' +input-file: +- Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json +``` + +### Tag: package-2016-05 + +These settings apply only when `--tag=package-2016-05` is specified on the command line. + +``` yaml $(tag) == 'package-2016-05' +input-file: +- Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_analysis_services'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Analysis + output-folder: $(csharp-sdks-folder)/AnalysisServices/Management.Analysis/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.analysisservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-analysisservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-05 + - tag: package-2017-07 + - tag: package-2017-08 + - tag: package-2017-08-beta +``` + +### Tag: package-2016-05 and java + +These settings apply only when `--tag=package-2016-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2016_05_16 + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2016_05_16 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-07 and java + +These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2017_07_14 + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_07_14 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-08 and java + +These settings apply only when `--tag=package-2017-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2017_08_01 + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-08-beta and java + +These settings apply only when `--tag=package-2017-08-beta --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08-beta' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.analysisservices.v2017_08_01_beta + output-folder: $(azure-libraries-for-java-folder)/analysisservices/resource-manager/v2017_08_01_beta +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index a5b8c749d671..8ee0a013ae20 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -1,239 +1,239 @@ -# Authorization - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Authorization. - - - ---- -## Getting Started -To build the SDK for Authorization, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Authorization API. - -``` yaml -openapi-type: arm -tag: package-2018-09-01-preview -``` - -## Suppression -``` yaml -directive: - - suppress: OperationsAPIImplementation - reason: we do have a operations api as "/providers/Microsoft.Authorization/operations" - #where: - # - $.paths["/providers/Microsoft.Authorization/operations"] - -``` - -### Tag: package-2015-07 - -These settings apply only when `--tag=package-2015-07` is specified on the command line. - -``` yaml $(tag) == 'package-2015-07' -input-file: -- Microsoft.Authorization/stable/2015-07-01/authorization.json -- Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json -``` - -### Tag: package-2015-07-authorization-only - -These settings apply only when `--tag=package-2015-07-authorization-only` is specified on the command line. - -``` yaml $(tag) == 'package-2015-07-authorization-only' -input-file: -- Microsoft.Authorization/stable/2015-07-01/authorization.json -``` - -### Tag: package-2015-06-01-preview - -These settings apply only when `--tag=package-2015-06-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-06-01-preview' -input-file: -- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -``` - -### Tag: package-2015-07-01-preview - -These settings apply only when `--tag=package-2015-07-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-07-01-preview' -input-file: -- Microsoft.Authorization/preview/2015-07-01/authorization.json -``` - -### Tag: package-2017-10-01-preview-only - -These settings apply only when `--tag=package-2017-10-01-preview-only` is specified on the command line. - -``` yaml $(tag) == 'package-2017-10-01-preview-only' -input-file: -- Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json -``` - -### Tag: package-2018-01-01-preview-only - -These settings apply only when `--tag=package-2018-01-01-preview-only` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01-01-preview-only' -input-file: -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json -``` - -### Tag: package-2018-07-01-preview-only - -These settings apply only when `--tag=package-2018-07-01-preview-only` is specified on the command line. - -``` yaml $(tag) == 'package-2018-07-01-preview-only' -input-file: -- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json -``` - -### Tag: package-2018-09-01-preview-only - -These settings apply only when `--tag=package-2018-09-01-preview-only` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09-01-preview-only' -input-file: -- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json -``` - -### Tag: package-2017-10-01-preview - -These settings apply only when `--tag=package-2017-10-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-10-01-preview' -input-file: -- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -- Microsoft.Authorization/preview/2015-07-01/authorization.json -- Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json -``` - -### Tag: package-2018-01-01-preview - -These settings apply only when `--tag=package-2018-01-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01-01-preview' -input-file: -- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json -``` - -### Tag: package-2018-07-01-preview - -These settings apply only when `--tag=package-2018-07-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-07-01-preview' -input-file: -- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json -- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json -``` - -### Tag: package-2018-09-01-preview - -These settings apply only when `--tag=package-2018-09-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09-01-preview' -input-file: -- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json -- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json -- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-authorization - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_authorization'] -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.authorization -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-authorization -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-07 - - tag: package-2018-09-01-preview -``` - -### Tag: package-2018-09-01-preview and java - -These settings apply only when `--tag=package-2018-09-01-preview --java` is specified on he command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-09-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.authorization.v2018_09_01_preview - output-folder: $(azure-libraries-for-java-folder)/authorization/resource-manager/v2018_09_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2015-07 and java - -These settings apply only when `--tag=package-2015-07 --java` is specified on he command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2015-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.authorization.v2015_07_01 - output-folder: $(azure-libraries-for-java-folder)/authorization/resource-manager/v2015_07_01 -regenerate-manager: true -generate-interface: true -``` +# Authorization + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Authorization. + + + +--- +## Getting Started +To build the SDK for Authorization, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Authorization API. + +``` yaml +openapi-type: arm +tag: package-2018-09-01-preview +``` + +## Suppression +``` yaml +directive: + - suppress: OperationsAPIImplementation + reason: we do have a operations api as "/providers/Microsoft.Authorization/operations" + #where: + # - $.paths["/providers/Microsoft.Authorization/operations"] + +``` + +### Tag: package-2015-07 + +These settings apply only when `--tag=package-2015-07` is specified on the command line. + +``` yaml $(tag) == 'package-2015-07' +input-file: +- Microsoft.Authorization/stable/2015-07-01/authorization.json +- Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json +``` + +### Tag: package-2015-07-authorization-only + +These settings apply only when `--tag=package-2015-07-authorization-only` is specified on the command line. + +``` yaml $(tag) == 'package-2015-07-authorization-only' +input-file: +- Microsoft.Authorization/stable/2015-07-01/authorization.json +``` + +### Tag: package-2015-06-01-preview + +These settings apply only when `--tag=package-2015-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json +``` + +### Tag: package-2015-07-01-preview + +These settings apply only when `--tag=package-2015-07-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-07-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-07-01/authorization.json +``` + +### Tag: package-2017-10-01-preview-only + +These settings apply only when `--tag=package-2017-10-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json +``` + +### Tag: package-2018-01-01-preview-only + +These settings apply only when `--tag=package-2018-01-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json +``` + +### Tag: package-2018-07-01-preview-only + +These settings apply only when `--tag=package-2018-07-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json +``` + +### Tag: package-2018-09-01-preview-only + +These settings apply only when `--tag=package-2018-09-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json +``` + +### Tag: package-2017-10-01-preview + +These settings apply only when `--tag=package-2017-10-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json +- Microsoft.Authorization/preview/2015-07-01/authorization.json +- Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json +``` + +### Tag: package-2018-01-01-preview + +These settings apply only when `--tag=package-2018-01-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json +``` + +### Tag: package-2018-07-01-preview + +These settings apply only when `--tag=package-2018-07-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json +- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json +``` + +### Tag: package-2018-09-01-preview + +These settings apply only when `--tag=package-2018-09-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-01-preview' +input-file: +- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json +- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-authorization + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_authorization'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.authorization +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-authorization +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-07 + - tag: package-2018-09-01-preview +``` + +### Tag: package-2018-09-01-preview and java + +These settings apply only when `--tag=package-2018-09-01-preview --java` is specified on he command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-09-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.authorization.v2018_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/authorization/resource-manager/v2018_09_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-07 and java + +These settings apply only when `--tag=package-2015-07 --java` is specified on he command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2015-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.authorization.v2015_07_01 + output-folder: $(azure-libraries-for-java-folder)/authorization/resource-manager/v2015_07_01 +regenerate-manager: true +generate-interface: true +``` 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 dc301c59af0f..8ea39ee3304e 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,278 +1,278 @@ -{ - "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" - ], - "targets": - { - "azureQueries":[ - { - "scope":[ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067" - ], - "tagSettings":{ - "tags":[ - { - "tag1": ["tag1Value1", "tag1Value2", "tag1Value3"] - }, - { - "tag2": ["tag2Value1", "tag2Value2", "tag2Value3"] - } - ], - "filterOperator" : "All" - }, - "locations":[ - "Japan East", - "UK South" - ] - } - ], - "nonAzureQueries":[ - { - "FunctionAlias": "SavedSearch1", - "WorkspaceId" : "WorkspaceId1" - }, - { - "FunctionAlias": "SavedSearch2", - "WorkspaceId" : "WorkspaceId2" - } - ] - - } - }, - "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" - ] - } - }, - "tasks": { - "preTask": { - "source": "HelloWorld", - "parameters": { - "COMPUTERNAME": "Computer1" - } - }, - "postTask": { - "source": "GetCache", - "parameters": null - } - } - } - } - }, - "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": {}, - "targets": { - "azureQueries": [ - { - "scope": [ - "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", - "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2" - ], - "tag2": [ - "tag2Value1", - "tag2Value2" - ] - }, - "filterOperator": "All" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - ] - }, - "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, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420, - "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": {} - }, - "tasks": { - "preTask": { - "source": "HelloWorld", - "parameters": { - "COMPUTERNAME": "Computer1" - } - }, - "postTask": { - "source": "GetCache", - "parameters": null - } - }, - "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": {}, - "targets": { - "azureQueries": [ - { - "scope": [ - "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", - "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2" - ], - "tag2": [ - "tag2Value1", - "tag2Value2" - ] - }, - "filterOperator": "All" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - ] - }, - "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, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420, - "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" - }, - "tasks": { - "preTask": { - "source": "HelloWorld", - "parameters": { - "COMPUTERNAME": "Computer1" - } - }, - "postTask": { - "source": "GetCache", - "parameters": null - } - }, - "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" + ], + "targets": + { + "azureQueries":[ + { + "scope":[ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067" + ], + "tagSettings":{ + "tags":[ + { + "tag1": ["tag1Value1", "tag1Value2", "tag1Value3"] + }, + { + "tag2": ["tag2Value1", "tag2Value2", "tag2Value3"] + } + ], + "filterOperator" : "All" + }, + "locations":[ + "Japan East", + "UK South" + ] + } + ], + "nonAzureQueries":[ + { + "FunctionAlias": "SavedSearch1", + "WorkspaceId" : "WorkspaceId1" + }, + { + "FunctionAlias": "SavedSearch2", + "WorkspaceId" : "WorkspaceId2" + } + ] + + } + }, + "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" + ] + } + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + } + } + } + }, + "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": {}, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" + ], + "tag2": [ + "tag2Value1", + "tag2Value2" + ] + }, + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + ] + }, + "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, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420, + "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": {} + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "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": {}, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" + ], + "tag2": [ + "tag2Value1", + "tag2Value2" + ] + }, + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + ] + }, + "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, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420, + "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" + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "provisioningState": "Provisioning", + "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/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 bc5ccd66bbce..c684999726f2 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,99 +1,99 @@ -{ - "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": {}, - "targets": { - "azureQueries": [ - { - "scope": [ - "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", - "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2" - ], - "tag2": [ - "tag2Value1", - "tag2Value2" - ] - }, - "filterOperator": "All" - }, - "locations": null - } - ] - }, - "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, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420, - "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" - }, - "tasks": { - "preTask": { - "source": "HelloWorld", - "parameters": { - "COMPUTERNAME": "Computer1" - } - }, - "postTask": { - "source": "GetCache", - "parameters": null - } - }, - "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": {}, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" + ], + "tag2": [ + "tag2Value1", + "tag2Value2" + ] + }, + "filterOperator": "All" + }, + "locations": null + } + ] + }, + "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, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420, + "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" + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "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/readme.md b/specification/automation/resource-manager/readme.md index e3fe750df431..898ddf071bdf 100644 --- a/specification/automation/resource-manager/readme.md +++ b/specification/automation/resource-manager/readme.md @@ -1,286 +1,286 @@ -# Automation - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Automation. - ---- -## Getting Started -To build the SDK for Automation, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - -======= -### Basic Information -These are the global settings for the Automation API. - -``` yaml -title: AutomationClient -description: Automation Client -openapi-type: arm -tag: package-2018-06-preview -``` - -### Tag: package-2015-10 - -These settings apply only when `--tag=package-2015-10` is specified on the command line. - -``` yaml $(tag) == 'package-2015-10' -input-file: -- Microsoft.Automation/stable/2015-10-31/account.json -- Microsoft.Automation/stable/2015-10-31/certificate.json -- Microsoft.Automation/stable/2015-10-31/connection.json -- Microsoft.Automation/stable/2015-10-31/connectionType.json -- Microsoft.Automation/stable/2015-10-31/credential.json -- Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json -- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json -- Microsoft.Automation/stable/2015-10-31/dscNode.json -- Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json -- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json -- Microsoft.Automation/stable/2015-10-31/job.json -- Microsoft.Automation/stable/2015-10-31/jobSchedule.json -- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json -- Microsoft.Automation/stable/2015-10-31/module.json -- Microsoft.Automation/stable/2015-10-31/runbook.json -- Microsoft.Automation/stable/2015-10-31/schedule.json -- Microsoft.Automation/stable/2015-10-31/variable.json -- Microsoft.Automation/stable/2015-10-31/webhook.json -``` - - -### Tag: package-2017-05-preview - -These settings apply only when `--tag=package-2017-05-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-05-preview' -input-file: -- Microsoft.Automation/stable/2015-10-31/account.json -- Microsoft.Automation/stable/2015-10-31/certificate.json -- Microsoft.Automation/stable/2015-10-31/connection.json -- Microsoft.Automation/stable/2015-10-31/connectionType.json -- Microsoft.Automation/stable/2015-10-31/credential.json -- Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json -- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json -- Microsoft.Automation/stable/2015-10-31/dscNode.json -- Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json -- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json -- Microsoft.Automation/stable/2015-10-31/jobSchedule.json -- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json -- Microsoft.Automation/stable/2015-10-31/module.json -- Microsoft.Automation/stable/2015-10-31/runbook.json -- Microsoft.Automation/stable/2015-10-31/schedule.json -- Microsoft.Automation/stable/2015-10-31/variable.json -- Microsoft.Automation/stable/2015-10-31/webhook.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json -- Microsoft.Automation/preview/2017-05-15-preview/job.json -``` - -### Tag: package-2018-01-preview - -These settings apply only when `--tag=package-2018-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01-preview' -input-file: -- Microsoft.Automation/stable/2015-10-31/account.json -- Microsoft.Automation/stable/2015-10-31/certificate.json -- Microsoft.Automation/stable/2015-10-31/connection.json -- Microsoft.Automation/stable/2015-10-31/connectionType.json -- Microsoft.Automation/stable/2015-10-31/credential.json -- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json -- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json -- Microsoft.Automation/stable/2015-10-31/jobSchedule.json -- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json -- Microsoft.Automation/stable/2015-10-31/module.json -- Microsoft.Automation/stable/2015-10-31/runbook.json -- Microsoft.Automation/stable/2015-10-31/schedule.json -- Microsoft.Automation/stable/2015-10-31/variable.json -- Microsoft.Automation/stable/2015-10-31/webhook.json -- Microsoft.Automation/stable/2015-10-31/watcher.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json -- Microsoft.Automation/preview/2017-05-15-preview/job.json -- Microsoft.Automation/stable/2018-01-15/dscNode.json -- Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json -- Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json -- Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json -``` - -### Tag: package-2018-06-preview - -These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-06-preview' -input-file: -- Microsoft.Automation/stable/2015-10-31/account.json -- Microsoft.Automation/stable/2015-10-31/certificate.json -- Microsoft.Automation/stable/2015-10-31/connection.json -- Microsoft.Automation/stable/2015-10-31/connectionType.json -- Microsoft.Automation/stable/2015-10-31/credential.json -- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json -- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json -- Microsoft.Automation/stable/2015-10-31/jobSchedule.json -- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json -- Microsoft.Automation/stable/2015-10-31/module.json -- Microsoft.Automation/stable/2015-10-31/schedule.json -- Microsoft.Automation/stable/2015-10-31/variable.json -- Microsoft.Automation/stable/2015-10-31/webhook.json -- Microsoft.Automation/stable/2015-10-31/watcher.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json -- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json -- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json -- Microsoft.Automation/preview/2017-05-15-preview/job.json -- Microsoft.Automation/stable/2018-01-15/dscNode.json -- Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json -- Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json -- Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json -- Microsoft.Automation/stable/2018-06-30/runbook.json -- Microsoft.Automation/stable/2018-06-30/python2package.json -``` - ---- -## Suppression -``` yaml -directive: - - suppress: RequiredPropertiesMissingInResourceModel - from: runbook.json - where: $.definitions.TestJob - - suppress: BodyTopLevelProperties - from: runbook.json - where: $.definitions.TestJob.properties - - suppress: DefinitionsPropertiesNamesCamelCase - from: account.json - where: $.definitions.Key.properties.KeyName - - suppress: DefinitionsPropertiesNamesCamelCase - from: account.json - where: $.definitions.Key.properties.Permissions - - suppress: DefinitionsPropertiesNamesCamelCase - from: account.json - where: $.definitions.Key.properties.Value - - suppress: LongRunningResponseStatusCode - from: runbook.json - where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/publish"].post["x-ms-long-running-operation"] - - suppress: LongRunningResponseStatusCode - from: runbook.json - where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/publish"].post["x-ms-long-running-operation"] -``` - ---- -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_automation'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Automation - output-folder: $(csharp-sdks-folder)/Automation/Management.Automation/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.automation - package-name: azure-mgmt-automation - package-version: 0.3.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-automation/azure/mgmt/automation -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-automation -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.automation -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-automation -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-10 -``` - -### Tag: package-2015-10 and java - -These settings apply only when `--tag=package-2015-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.automation.v2015_10_31 - output-folder: $(azure-libraries-for-java-folder)/automation/resource-manager/v2015_10_31 -regenerate-manager: true -generate-interface: true -``` - - +# Automation + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Automation. + +--- +## Getting Started +To build the SDK for Automation, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +======= +### Basic Information +These are the global settings for the Automation API. + +``` yaml +title: AutomationClient +description: Automation Client +openapi-type: arm +tag: package-2018-06-preview +``` + +### Tag: package-2015-10 + +These settings apply only when `--tag=package-2015-10` is specified on the command line. + +``` yaml $(tag) == 'package-2015-10' +input-file: +- Microsoft.Automation/stable/2015-10-31/account.json +- Microsoft.Automation/stable/2015-10-31/certificate.json +- Microsoft.Automation/stable/2015-10-31/connection.json +- Microsoft.Automation/stable/2015-10-31/connectionType.json +- Microsoft.Automation/stable/2015-10-31/credential.json +- Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json +- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json +- Microsoft.Automation/stable/2015-10-31/dscNode.json +- Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json +- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json +- Microsoft.Automation/stable/2015-10-31/job.json +- Microsoft.Automation/stable/2015-10-31/jobSchedule.json +- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json +- Microsoft.Automation/stable/2015-10-31/module.json +- Microsoft.Automation/stable/2015-10-31/runbook.json +- Microsoft.Automation/stable/2015-10-31/schedule.json +- Microsoft.Automation/stable/2015-10-31/variable.json +- Microsoft.Automation/stable/2015-10-31/webhook.json +``` + + +### Tag: package-2017-05-preview + +These settings apply only when `--tag=package-2017-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-05-preview' +input-file: +- Microsoft.Automation/stable/2015-10-31/account.json +- Microsoft.Automation/stable/2015-10-31/certificate.json +- Microsoft.Automation/stable/2015-10-31/connection.json +- Microsoft.Automation/stable/2015-10-31/connectionType.json +- Microsoft.Automation/stable/2015-10-31/credential.json +- Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json +- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json +- Microsoft.Automation/stable/2015-10-31/dscNode.json +- Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json +- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json +- Microsoft.Automation/stable/2015-10-31/jobSchedule.json +- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json +- Microsoft.Automation/stable/2015-10-31/module.json +- Microsoft.Automation/stable/2015-10-31/runbook.json +- Microsoft.Automation/stable/2015-10-31/schedule.json +- Microsoft.Automation/stable/2015-10-31/variable.json +- Microsoft.Automation/stable/2015-10-31/webhook.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json +- Microsoft.Automation/preview/2017-05-15-preview/job.json +``` + +### Tag: package-2018-01-preview + +These settings apply only when `--tag=package-2018-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-preview' +input-file: +- Microsoft.Automation/stable/2015-10-31/account.json +- Microsoft.Automation/stable/2015-10-31/certificate.json +- Microsoft.Automation/stable/2015-10-31/connection.json +- Microsoft.Automation/stable/2015-10-31/connectionType.json +- Microsoft.Automation/stable/2015-10-31/credential.json +- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json +- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json +- Microsoft.Automation/stable/2015-10-31/jobSchedule.json +- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json +- Microsoft.Automation/stable/2015-10-31/module.json +- Microsoft.Automation/stable/2015-10-31/runbook.json +- Microsoft.Automation/stable/2015-10-31/schedule.json +- Microsoft.Automation/stable/2015-10-31/variable.json +- Microsoft.Automation/stable/2015-10-31/webhook.json +- Microsoft.Automation/stable/2015-10-31/watcher.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json +- Microsoft.Automation/preview/2017-05-15-preview/job.json +- Microsoft.Automation/stable/2018-01-15/dscNode.json +- Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json +- Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json +- Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json +``` + +### Tag: package-2018-06-preview + +These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' +input-file: +- Microsoft.Automation/stable/2015-10-31/account.json +- Microsoft.Automation/stable/2015-10-31/certificate.json +- Microsoft.Automation/stable/2015-10-31/connection.json +- Microsoft.Automation/stable/2015-10-31/connectionType.json +- Microsoft.Automation/stable/2015-10-31/credential.json +- Microsoft.Automation/stable/2015-10-31/dscConfiguration.json +- Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json +- Microsoft.Automation/stable/2015-10-31/jobSchedule.json +- Microsoft.Automation/stable/2015-10-31/linkedWorkspace.json +- Microsoft.Automation/stable/2015-10-31/module.json +- Microsoft.Automation/stable/2015-10-31/schedule.json +- Microsoft.Automation/stable/2015-10-31/variable.json +- Microsoft.Automation/stable/2015-10-31/webhook.json +- Microsoft.Automation/stable/2015-10-31/watcher.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json +- Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +- Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJobStreams.json +- Microsoft.Automation/preview/2017-05-15-preview/job.json +- Microsoft.Automation/stable/2018-01-15/dscNode.json +- Microsoft.Automation/stable/2018-01-15/dscCompilationJob.json +- Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json +- Microsoft.Automation/stable/2018-01-15/dscNodeCounts.json +- Microsoft.Automation/stable/2018-06-30/runbook.json +- Microsoft.Automation/stable/2018-06-30/python2package.json +``` + +--- +## Suppression +``` yaml +directive: + - suppress: RequiredPropertiesMissingInResourceModel + from: runbook.json + where: $.definitions.TestJob + - suppress: BodyTopLevelProperties + from: runbook.json + where: $.definitions.TestJob.properties + - suppress: DefinitionsPropertiesNamesCamelCase + from: account.json + where: $.definitions.Key.properties.KeyName + - suppress: DefinitionsPropertiesNamesCamelCase + from: account.json + where: $.definitions.Key.properties.Permissions + - suppress: DefinitionsPropertiesNamesCamelCase + from: account.json + where: $.definitions.Key.properties.Value + - suppress: LongRunningResponseStatusCode + from: runbook.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/publish"].post["x-ms-long-running-operation"] + - suppress: LongRunningResponseStatusCode + from: runbook.json + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/publish"].post["x-ms-long-running-operation"] +``` + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_automation'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Automation + output-folder: $(csharp-sdks-folder)/Automation/Management.Automation/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.automation + package-name: azure-mgmt-automation + package-version: 0.3.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-automation/azure/mgmt/automation +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-automation +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.automation +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-automation +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10 +``` + +### Tag: package-2015-10 and java + +These settings apply only when `--tag=package-2015-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.automation.v2015_10_31 + output-folder: $(azure-libraries-for-java-folder)/automation/resource-manager/v2015_10_31 +regenerate-manager: true +generate-interface: true +``` + + 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/2015-12-01/acquisitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json index 8aaa8b45b58b..69c1bbaefb32 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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 acquisitions.": { - "$ref": "./examples/Acquisitions/List.json" - } - }, - "tags": [ - "Acquisitions" - ], - "operationId": "Acquisitions_List", - "description": "Returns a list of BLOB acquisitions.", - "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 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 acquisitions.": { + "$ref": "./examples/Acquisitions/List.json" + } + }, + "tags": [ + "Acquisitions" + ], + "operationId": "Acquisitions_List", + "description": "Returns a list of BLOB acquisitions.", + "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 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/2015-12-01/blobServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json index 377ed7d08f7a..7581c851cbaa 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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/2015-12-01/containers.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/containers.json index 59ba4701c518..5a7798e5c6fe 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/containers.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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/2015-12-01/farms.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/farms.json index 7159cb373383..afcb3653442c 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/farms.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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/2015-12-01/queueServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json index 63faf4913473..bd7b428b1269 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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/2015-12-01/quotas.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json index 6c4649fd869a..d66bea14f786 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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": "Maximum 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": "Maximum 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/2015-12-01/shares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/shares.json index c116c0201495..146c5992d2dd 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/shares.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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/2015-12-01/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storage.json index f02b77dc14a9..a991c46378c8 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storage.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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": "Maximum 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": "Maximum 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/2015-12-01/storageaccounts.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json index 7820cb16398c..e1cf42d9f535 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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/2015-12-01/tableServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json index edfb7523ccaa..198a7fb86e34 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-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 service.": { - "$ref": "./examples/TableService/Get.json" - } - }, - "tags": [ - "TableServices" - ], - "description": "Returns the table service.", - "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 service.": { + "$ref": "./examples/TableService/Get.json" + } + }, + "tags": [ + "TableServices" + ], + "description": "Returns the table service.", + "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/batch/data-plane/readme.md b/specification/batch/data-plane/readme.md index 1a02fcd81584..385f2e978ece 100644 --- a/specification/batch/data-plane/readme.md +++ b/specification/batch/data-plane/readme.md @@ -1,322 +1,322 @@ -# Batch - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Batch. - - - ---- -## Getting Started -To build the SDK for Batch, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Batch API. - -``` yaml -openapi-type: data-plane -tag: package-2018-12.8.0 -``` - -### Tag: package-2018-12.8.0 - -These settings apply only when `--tag=package-2018-12.8.0` is specified on the command line. - -``` yaml $(tag) == 'package-2018-12.8.0' -input-file: -- Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json -``` - -### Tag: package-2018-08.7.0 - -These settings apply only when `--tag=package-2018-08.7.0` is specified on the command line. - -``` yaml $(tag) == 'package-2018-08.7.0' -input-file: -- Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json -``` - -### Tag: package-2018-03.6.1 - -These settings apply only when `--tag=package-2018-03.6.1` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03.6.1' -input-file: -- Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json -``` - -### Tag: package-2017-09.6.0 - -These settings apply only when `--tag=package-2017-09.6.0` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09.6.0' -input-file: -- Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json -``` - -### Tag: package-2017-06.5.1 - -These settings apply only when `--tag=package-2017-06.5.1` is specified on the command line. - -``` yaml $(tag) == 'package-2017-06.5.1' -input-file: -- Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json -``` - -## Suppression - -Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/68) is fixed. -``` yaml -directive: - - suppress: R2063 - from: BatchService.json - reason: Bug in linter -``` - -Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/69) is fixed. -``` yaml -directive: - - suppress: R2064 - from: BatchService.json - reason: This is a data plane swagger specification, LRO's do not apply -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $..["odata.nextLink"] - reason: The casing of this property is not incorrect. -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $..["publicFQDN"] - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobScheduleStatistics.properties.kernelCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.TaskStatistics.properties.userCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.TaskStatistics.properties.kernelCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobScheduleStatistics.properties.userCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobStatistics.properties.kernelCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.JobStatistics.properties.userCPUTime - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.ResourceStatistics.properties.avgCPUPercentage - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.PoolEndpointConfiguration.properties.inboundNATPools - reason: The suggested casing of this property is worse than the casing that we're using -``` - -``` yaml -directive: - - suppress: R3016 - from: BatchService.json - where: $.definitions.VirtualMachineConfiguration.properties.nodeAgentSKUId - reason: The suggested casing of this property is worse than the casing that we're using -``` - -### Tag: package-2017-05.5.0 - -These settings apply only when `--tag=package-2017-05.5.0` is specified on the command line. - -``` yaml $(tag) == 'package-2017-05.5.0' -input-file: -- Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json -``` - - -### Tag: package-2017-01.4.0 - -These settings apply only when `--tag=package-2017-01.4.0` is specified on the command line. - -``` yaml $(tag) == 'package-2017-01.4.0' -input-file: -- Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json -``` - -### Tag: package-2016-07.3.1 - -These settings apply only when `--tag=package-2016-07.3.1` is specified on the command line. - -``` yaml $(tag) == 'package-2016-07.3.1' -input-file: -- Microsoft.Batch/stable/2016-07-01.3.1/BatchService.json -``` - -### Tag: package-2016-02.3.0 - -These settings apply only when `--tag=package-2016-02.3.0` is specified on the command line. - -``` yaml $(tag) == 'package-2016-02.3.0' -input-file: -- Microsoft.Batch/stable/2016-02-01.3.0/BatchService.json -``` - -### Tag: package-2015-12.2.2 - -These settings apply only when `--tag=package-2015-12.2.2` is specified on the command line. - -``` yaml $(tag) == 'package-2015-12.2.2' -input-file: -- Microsoft.Batch/stable/2015-12-01.2.2/BatchService.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 1 - namespace: Microsoft.Azure.Batch.Protocol - output-folder: $(csharp-sdks-folder)/Batch/DataPlane/Azure.Batch/GeneratedProtocol - clear-output-folder: true - client-side-validation: false -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.batch - package-name: azure-batch - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-batch/azure/batch -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-batch -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(java) -nodejs: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: com.microsoft.azure.batch.protocol - output-folder: $(node-sdks-folder)/src/main/java - payload-flattening-threshold: 1 - generate-license-txt: true - clear-output-folder: true -``` - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.batch - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-batch -``` +# Batch + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Batch. + + + +--- +## Getting Started +To build the SDK for Batch, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Batch API. + +``` yaml +openapi-type: data-plane +tag: package-2018-12.8.0 +``` + +### Tag: package-2018-12.8.0 + +These settings apply only when `--tag=package-2018-12.8.0` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12.8.0' +input-file: +- Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json +``` + +### Tag: package-2018-08.7.0 + +These settings apply only when `--tag=package-2018-08.7.0` is specified on the command line. + +``` yaml $(tag) == 'package-2018-08.7.0' +input-file: +- Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json +``` + +### Tag: package-2018-03.6.1 + +These settings apply only when `--tag=package-2018-03.6.1` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03.6.1' +input-file: +- Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json +``` + +### Tag: package-2017-09.6.0 + +These settings apply only when `--tag=package-2017-09.6.0` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09.6.0' +input-file: +- Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json +``` + +### Tag: package-2017-06.5.1 + +These settings apply only when `--tag=package-2017-06.5.1` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06.5.1' +input-file: +- Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json +``` + +## Suppression + +Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/68) is fixed. +``` yaml +directive: + - suppress: R2063 + from: BatchService.json + reason: Bug in linter +``` + +Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/69) is fixed. +``` yaml +directive: + - suppress: R2064 + from: BatchService.json + reason: This is a data plane swagger specification, LRO's do not apply +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $..["odata.nextLink"] + reason: The casing of this property is not incorrect. +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $..["publicFQDN"] + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.JobScheduleStatistics.properties.kernelCPUTime + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.TaskStatistics.properties.userCPUTime + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.TaskStatistics.properties.kernelCPUTime + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.JobScheduleStatistics.properties.userCPUTime + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.JobStatistics.properties.kernelCPUTime + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.JobStatistics.properties.userCPUTime + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.ResourceStatistics.properties.avgCPUPercentage + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.PoolEndpointConfiguration.properties.inboundNATPools + reason: The suggested casing of this property is worse than the casing that we're using +``` + +``` yaml +directive: + - suppress: R3016 + from: BatchService.json + where: $.definitions.VirtualMachineConfiguration.properties.nodeAgentSKUId + reason: The suggested casing of this property is worse than the casing that we're using +``` + +### Tag: package-2017-05.5.0 + +These settings apply only when `--tag=package-2017-05.5.0` is specified on the command line. + +``` yaml $(tag) == 'package-2017-05.5.0' +input-file: +- Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json +``` + + +### Tag: package-2017-01.4.0 + +These settings apply only when `--tag=package-2017-01.4.0` is specified on the command line. + +``` yaml $(tag) == 'package-2017-01.4.0' +input-file: +- Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json +``` + +### Tag: package-2016-07.3.1 + +These settings apply only when `--tag=package-2016-07.3.1` is specified on the command line. + +``` yaml $(tag) == 'package-2016-07.3.1' +input-file: +- Microsoft.Batch/stable/2016-07-01.3.1/BatchService.json +``` + +### Tag: package-2016-02.3.0 + +These settings apply only when `--tag=package-2016-02.3.0` is specified on the command line. + +``` yaml $(tag) == 'package-2016-02.3.0' +input-file: +- Microsoft.Batch/stable/2016-02-01.3.0/BatchService.json +``` + +### Tag: package-2015-12.2.2 + +These settings apply only when `--tag=package-2015-12.2.2` is specified on the command line. + +``` yaml $(tag) == 'package-2015-12.2.2' +input-file: +- Microsoft.Batch/stable/2015-12-01.2.2/BatchService.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + namespace: Microsoft.Azure.Batch.Protocol + output-folder: $(csharp-sdks-folder)/Batch/DataPlane/Azure.Batch/GeneratedProtocol + clear-output-folder: true + client-side-validation: false +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.batch + package-name: azure-batch + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-batch/azure/batch +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-batch +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(java) +nodejs: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: com.microsoft.azure.batch.protocol + output-folder: $(node-sdks-folder)/src/main/java + payload-flattening-threshold: 1 + generate-license-txt: true + clear-output-folder: true +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.batch + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-batch +``` diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index 82e19f2c833d..c0f556d79c7e 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -1,269 +1,269 @@ -# Batch - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Batch. - ---- - -## Getting Started - -To build the SDK for Batch, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the Batch API. - -``` yaml -openapi-type: arm -tag: package-2019-04 -``` - - -### Tag: package-2019-04 - -These settings apply only when `--tag=package-2019-04` is specified on the command line. - -```yaml $(tag) == 'package-2019-04' -input-file: - - Microsoft.Batch/stable/2019-04-01/BatchManagement.json -``` -### Tag: package-2018-12 - -These settings apply only when `--tag=package-2018-12` is specified on the command line. - -``` yaml $(tag) == 'package-2018-12' -input-file: - - Microsoft.Batch/stable/2018-12-01/BatchManagement.json -``` - -### Tag: package-2017-09 - -These settings apply only when `--tag=package-2017-09` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09' -input-file: -- Microsoft.Batch/stable/2017-09-01/BatchManagement.json -``` - -## Suppression - -Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/68) is fixed. - -``` yaml -directive: - - suppress: R2063 - from: BatchManagement.json - reason: Bug in linter - - from: - - 2017-09-01/BatchManagement.json - - 2017-05-01/BatchManagement.json - - 2017-01-01/BatchManagement.json - - 2015-12-01/BatchManagement.json - where: - - $.definitions.Application - - $.definitions.ApplicationPackage - suppress: - - R2020 - reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future next API versions. - - from: - - 2017-09-01/BatchManagement.json - - 2017-05-01/BatchManagement.json - - 2017-01-01/BatchManagement.json - - 2015-12-01/BatchManagement.json - where: - - $.definitions.Application.properties - - $.definitions.ApplicationPackage.properties - suppress: - - R3006 - reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future API versions. - - suppress: OBJECT_MISSING_REQUIRED_PROPERTY - from: BatchManagement.json - where: $.definitions.UserAccount - reason: This field contains a secret (password) and is not returned on a get (but is required on a PUT/PATCH). Previous discussions with the modelling team had said that this was the correct way to model this type of field. -``` - -### Tag: package-2017-05 - -These settings apply only when `--tag=package-2017-05` is specified on the command line. - -``` yaml $(tag) == 'package-2017-05' -input-file: -- Microsoft.Batch/stable/2017-05-01/BatchManagement.json -``` - -### Tag: package-2017-01 - -These settings apply only when `--tag=package-2017-01` is specified on the command line. - -``` yaml $(tag) == 'package-2017-01' -input-file: -- Microsoft.Batch/stable/2017-01-01/BatchManagement.json -``` - -### Tag: package-2015-12 - -These settings apply only when `--tag=package-2015-12` is specified on the command line. - -``` yaml $(tag) == 'package-2015-12' -input-file: -- Microsoft.Batch/stable/2015-12-01/BatchManagement.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_batch'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # last generated with AutoRest.1.0.0-Nightly20170129 from commit 19f63015ea5a8a0fc64b9d7e2cdfeac447d93eaf - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Batch - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/Batch/Management/Management.Batch/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.batch - package-name: azure-mgmt-batch - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-batch/azure/mgmt/batch -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-batch -``` - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.batch -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-batch -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-12 - - tag: package-2017-09 - - tag: package-2017-01 - - tag: package-2017-05 -``` - -### Tag: package-2015-12 and java - -These settings apply only when `--tag=package-2015-12 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-12' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.batch.v2015_12_01 - output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2015_12_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-09 and java - -These settings apply only when `--tag=package-2017-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.batch.v2017_09_01 - output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_09_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-01 and java - -These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.batch.v2017_01_01 - output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_01_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-05 and java - -These settings apply only when `--tag=package-2017-05 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-05' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.batch.v2017_05_01 - output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_05_01 -regenerate-manager: true -generate-interface: true -``` - -` +# Batch + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Batch. + +--- + +## Getting Started + +To build the SDK for Batch, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Batch API. + +``` yaml +openapi-type: arm +tag: package-2019-04 +``` + + +### Tag: package-2019-04 + +These settings apply only when `--tag=package-2019-04` is specified on the command line. + +```yaml $(tag) == 'package-2019-04' +input-file: + - Microsoft.Batch/stable/2019-04-01/BatchManagement.json +``` +### Tag: package-2018-12 + +These settings apply only when `--tag=package-2018-12` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12' +input-file: + - Microsoft.Batch/stable/2018-12-01/BatchManagement.json +``` + +### Tag: package-2017-09 + +These settings apply only when `--tag=package-2017-09` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09' +input-file: +- Microsoft.Batch/stable/2017-09-01/BatchManagement.json +``` + +## Suppression + +Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/68) is fixed. + +``` yaml +directive: + - suppress: R2063 + from: BatchManagement.json + reason: Bug in linter + - from: + - 2017-09-01/BatchManagement.json + - 2017-05-01/BatchManagement.json + - 2017-01-01/BatchManagement.json + - 2015-12-01/BatchManagement.json + where: + - $.definitions.Application + - $.definitions.ApplicationPackage + suppress: + - R2020 + reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future next API versions. + - from: + - 2017-09-01/BatchManagement.json + - 2017-05-01/BatchManagement.json + - 2017-01-01/BatchManagement.json + - 2015-12-01/BatchManagement.json + where: + - $.definitions.Application.properties + - $.definitions.ApplicationPackage.properties + suppress: + - R3006 + reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future API versions. + - suppress: OBJECT_MISSING_REQUIRED_PROPERTY + from: BatchManagement.json + where: $.definitions.UserAccount + reason: This field contains a secret (password) and is not returned on a get (but is required on a PUT/PATCH). Previous discussions with the modelling team had said that this was the correct way to model this type of field. +``` + +### Tag: package-2017-05 + +These settings apply only when `--tag=package-2017-05` is specified on the command line. + +``` yaml $(tag) == 'package-2017-05' +input-file: +- Microsoft.Batch/stable/2017-05-01/BatchManagement.json +``` + +### Tag: package-2017-01 + +These settings apply only when `--tag=package-2017-01` is specified on the command line. + +``` yaml $(tag) == 'package-2017-01' +input-file: +- Microsoft.Batch/stable/2017-01-01/BatchManagement.json +``` + +### Tag: package-2015-12 + +These settings apply only when `--tag=package-2015-12` is specified on the command line. + +``` yaml $(tag) == 'package-2015-12' +input-file: +- Microsoft.Batch/stable/2015-12-01/BatchManagement.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_batch'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # last generated with AutoRest.1.0.0-Nightly20170129 from commit 19f63015ea5a8a0fc64b9d7e2cdfeac447d93eaf + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Batch + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Batch/Management/Management.Batch/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.batch + package-name: azure-mgmt-batch + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-batch/azure/mgmt/batch +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-batch +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.batch +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-batch +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-12 + - tag: package-2017-09 + - tag: package-2017-01 + - tag: package-2017-05 +``` + +### Tag: package-2015-12 and java + +These settings apply only when `--tag=package-2015-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-12' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batch.v2015_12_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2015_12_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-09 and java + +These settings apply only when `--tag=package-2017-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batch.v2017_09_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-01 and java + +These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batch.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-05 and java + +These settings apply only when `--tag=package-2017-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.batch.v2017_05_01 + output-folder: $(azure-libraries-for-java-folder)/batch/resource-manager/v2017_05_01 +regenerate-manager: true +generate-interface: true +``` + +` 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/readme.md b/specification/billing/resource-manager/readme.md index ef1b634cd5f2..67b98f84dab4 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -1,212 +1,212 @@ -# Billing - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Billing. - - - ---- -## Getting Started -To build the SDK for Billing, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Billing API. - -``` yaml -openapi-type: arm -tag: package-2018-11-preview -``` - -### Tag: package-2018-11-preview - -These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-11-preview' -input-file: -- Microsoft.Billing/preview/2018-11-01-preview/billing.json -``` - -### Tag: package-2018-03-preview - -These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03-preview' -input-file: -- Microsoft.Billing/preview/2018-03-01-preview/billing.json -``` - -### Tag: package-2017-04-preview - -These settings apply only when `--tag=package-2017-04-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04-preview' -input-file: -- Microsoft.Billing/preview/2017-04-24-preview/billing.json -``` - -### Tag: package-2017-02-preview - -These settings apply only when `--tag=package-2017-02-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-02-preview' -input-file: -- Microsoft.Billing/preview/2017-02-27-preview/billing.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_billing'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Billing - output-folder: $(csharp-sdks-folder)/Billing/Management.Billing/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.billing - package-name: azure-mgmt-billing - package-version: 0.2.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-billing/azure/mgmt/billing -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-billing -``` - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.billing -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-billing -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-11-preview - - tag: package-2018-03-preview - - tag: package-2017-04-preview - - tag: package-2017-02-preview -``` - -### Tag: package-2018-11-preview and java - -These settings apply only when `--tag=package-2018-11-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-11-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.billing.v2018_11_01_preview - output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2018_11_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-03-preview and java - -These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.billing.v2018_03_01_preview - output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2018_03_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04-preview and java - -These settings apply only when `--tag=package-2017-04-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.billing.v2017_04_24_preview - output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2017_04_24_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-02-preview and java - -These settings apply only when `--tag=package-2017-02-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.billing.v2017_02_27_preview - output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2017_02_27_preview -regenerate-manager: true -generate-interface: true -``` - - +# Billing + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Billing. + + + +--- +## Getting Started +To build the SDK for Billing, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Billing API. + +``` yaml +openapi-type: arm +tag: package-2018-11-preview +``` + +### Tag: package-2018-11-preview + +These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11-preview' +input-file: +- Microsoft.Billing/preview/2018-11-01-preview/billing.json +``` + +### Tag: package-2018-03-preview + +These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-preview' +input-file: +- Microsoft.Billing/preview/2018-03-01-preview/billing.json +``` + +### Tag: package-2017-04-preview + +These settings apply only when `--tag=package-2017-04-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04-preview' +input-file: +- Microsoft.Billing/preview/2017-04-24-preview/billing.json +``` + +### Tag: package-2017-02-preview + +These settings apply only when `--tag=package-2017-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-02-preview' +input-file: +- Microsoft.Billing/preview/2017-02-27-preview/billing.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_billing'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Billing + output-folder: $(csharp-sdks-folder)/Billing/Management.Billing/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.billing + package-name: azure-mgmt-billing + package-version: 0.2.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-billing/azure/mgmt/billing +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-billing +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.billing +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-billing +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-11-preview + - tag: package-2018-03-preview + - tag: package-2017-04-preview + - tag: package-2017-02-preview +``` + +### Tag: package-2018-11-preview and java + +These settings apply only when `--tag=package-2018-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.billing.v2018_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2018_11_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03-preview and java + +These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.billing.v2018_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2018_03_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04-preview and java + +These settings apply only when `--tag=package-2017-04-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.billing.v2017_04_24_preview + output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2017_04_24_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-02-preview and java + +These settings apply only when `--tag=package-2017-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.billing.v2017_02_27_preview + output-folder: $(azure-libraries-for-java-folder)/billing/resource-manager/v2017_02_27_preview +regenerate-manager: true +generate-interface: true +``` + + 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 d37741cf17ca..c4c0937d18bb 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": "Display Name of the Service Provider", - "readOnly": true - }, - "serviceProviderName": { - "type": "string", - "description": "Display Name of the Service Provider", - "readOnly": true - }, - "devPortalUrl": { - "type": "string", - "description": "Display Name of the Service Provider", - "readOnly": true - }, - "iconUrl": { - "type": "string", - "description": "Display 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": "Display Name of the Service Provider", + "readOnly": true + }, + "serviceProviderName": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "devPortalUrl": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "iconUrl": { + "type": "string", + "description": "Display 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..114767633d30 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..e7397175954b 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..a7dd6169b072 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..9e5efe73976b 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..a9bccc87b994 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..38dca2a0eafd 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/readme.md b/specification/botservice/resource-manager/readme.md index d9621f5b4be9..5ae21e56ac3d 100644 --- a/specification/botservice/resource-manager/readme.md +++ b/specification/botservice/resource-manager/readme.md @@ -1,143 +1,143 @@ -# BotService - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for BotService. - - - ---- - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-12-01 - - tag: package-2018-07-12 -``` - -### Tag: package-2018-07-12 and java - -These settings apply only when `--tag=package-2018-07-12 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-07-12' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.botservice.v2018-07-12 - output-folder: $(azure-libraries-for-java-folder)/botservice/resource-manager/v2018-07-12 -regenerate-manager: true -generate-interface: true -``` -### Tag: package-2017-12-01 and java - -These settings apply only when `--tag=package-2017-12-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.botservice.v2017_12_01 - output-folder: $(azure-libraries-for-java-folder)/botservice/resource-manager/v2017_12_01 -regenerate-manager: true -generate-interface: true -``` - -## Getting Started -To build the SDK for BotService, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the BotService API. - -``` yaml -openapi-type: arm -tag: package-2018-07-12 -``` - -### Tag: package-2018-07-12 - -These settings apply only when `--tag=package-2018-07-12` is specified on the command line. - -``` yaml $(tag) == 'package-2018-07-12' -input-file: -- Microsoft.BotService/preview/2018-07-12/botservice.json -directive: - - suppress: R3010 - from: botservice.json - reason: It is not a useful operation in the bot service. - - suppress: R2001 - from: botservice.json - reason: Flatten does not improve the programming experience here. - - suppress: R3018 - from: botservice.json - reason: We used Enums where we might extend to multiple states, and left booleans where it would ease development. - - suppress: R2066 - from: botservice.json - reason: The path as-is is quite descriptive. -``` - -### Tag: package-2017-12-01 - -These settings apply only when `--tag=package-2017-12-01` is specified on the command line. - -``` yaml $(tag) == 'package-2017-12-01' -input-file: -- Microsoft.BotService/preview/2017-12-01/botservice.json -directive: - - suppress: R3010 - from: botservice.json - reason: It is not a useful operation in the bot service. - - suppress: R2001 - from: botservice.json - reason: Flatten does not improve the programming experience here. - - suppress: R3018 - from: botservice.json - reason: We used Enums where we might extend to multiple states, and left booleans where it would ease development. - - suppress: R2066 - from: botservice.json - reason: The path as-is is quite descriptive. -``` ---- -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-go -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.BotService - output-folder: $(csharp-sdks-folder)/BotService/Microsoft.Azure.Management.BotService/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -See readme.python.md file. +# BotService + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for BotService. + + + +--- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-12-01 + - tag: package-2018-07-12 +``` + +### Tag: package-2018-07-12 and java + +These settings apply only when `--tag=package-2018-07-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-07-12' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.botservice.v2018-07-12 + output-folder: $(azure-libraries-for-java-folder)/botservice/resource-manager/v2018-07-12 +regenerate-manager: true +generate-interface: true +``` +### Tag: package-2017-12-01 and java + +These settings apply only when `--tag=package-2017-12-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.botservice.v2017_12_01 + output-folder: $(azure-libraries-for-java-folder)/botservice/resource-manager/v2017_12_01 +regenerate-manager: true +generate-interface: true +``` + +## Getting Started +To build the SDK for BotService, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the BotService API. + +``` yaml +openapi-type: arm +tag: package-2018-07-12 +``` + +### Tag: package-2018-07-12 + +These settings apply only when `--tag=package-2018-07-12` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-12' +input-file: +- Microsoft.BotService/preview/2018-07-12/botservice.json +directive: + - suppress: R3010 + from: botservice.json + reason: It is not a useful operation in the bot service. + - suppress: R2001 + from: botservice.json + reason: Flatten does not improve the programming experience here. + - suppress: R3018 + from: botservice.json + reason: We used Enums where we might extend to multiple states, and left booleans where it would ease development. + - suppress: R2066 + from: botservice.json + reason: The path as-is is quite descriptive. +``` + +### Tag: package-2017-12-01 + +These settings apply only when `--tag=package-2017-12-01` is specified on the command line. + +``` yaml $(tag) == 'package-2017-12-01' +input-file: +- Microsoft.BotService/preview/2017-12-01/botservice.json +directive: + - suppress: R3010 + from: botservice.json + reason: It is not a useful operation in the bot service. + - suppress: R2001 + from: botservice.json + reason: Flatten does not improve the programming experience here. + - suppress: R3018 + from: botservice.json + reason: We used Enums where we might extend to multiple states, and left booleans where it would ease development. + - suppress: R2066 + from: botservice.json + reason: The path as-is is quite descriptive. +``` +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-go +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.BotService + output-folder: $(csharp-sdks-folder)/BotService/Microsoft.Azure.Management.BotService/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See readme.python.md file. diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index 137ee3956bcb..e2d41db83730 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -1,123 +1,123 @@ -# Cdn - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Cdn. - - - ---- -## Getting Started -To build the SDK for Cdn, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Cdn API. - -``` yaml -openapi-type: arm -tag: package-2017-10 -``` - -### Tag: package-2017-10 - -These settings apply only when `--tag=package-2017-10` is specified on the command line. - -``` yaml $(tag) == 'package-2017-10' -input-file: -- Microsoft.Cdn/stable/2017-10-12/cdn.json -``` - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.Cdn/stable/2017-04-02/cdn.json -``` - -### Tag: package-2016-10 - -These settings apply only when `--tag=package-2016-10` is specified on the command line. - -``` yaml $(tag) == 'package-2016-10' -input-file: -- Microsoft.Cdn/stable/2016-10-02/cdn.json -``` - -### Tag: package-2016-04 - -These settings apply only when `--tag=package-2016-04` is specified on the command line. - -``` yaml $(tag) == 'package-2016-04' -input-file: -- Microsoft.Cdn/stable/2016-04-02/cdn.json -``` - -### Tag: package-2015-06 - -These settings apply only when `--tag=package-2015-06` is specified on the command line. - -``` yaml $(tag) == 'package-2015-06' -input-file: -- Microsoft.Cdn/stable/2015-06-01/cdn.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-net - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_cdn'] -``` - - -## C# - -See configuration in [readme.csharp.md](./readme.csharp.md) - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -See configuration in [readme.java.md](./readme.java.md) - -## Node - -See configuration in [readme.node.md](./readme.node.md) - -## Ruby - -See configuration in [readme.ruby.md](./readme.ruby.md) +# Cdn + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Cdn. + + + +--- +## Getting Started +To build the SDK for Cdn, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Cdn API. + +``` yaml +openapi-type: arm +tag: package-2017-10 +``` + +### Tag: package-2017-10 + +These settings apply only when `--tag=package-2017-10` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10' +input-file: +- Microsoft.Cdn/stable/2017-10-12/cdn.json +``` + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.Cdn/stable/2017-04-02/cdn.json +``` + +### Tag: package-2016-10 + +These settings apply only when `--tag=package-2016-10` is specified on the command line. + +``` yaml $(tag) == 'package-2016-10' +input-file: +- Microsoft.Cdn/stable/2016-10-02/cdn.json +``` + +### Tag: package-2016-04 + +These settings apply only when `--tag=package-2016-04` is specified on the command line. + +``` yaml $(tag) == 'package-2016-04' +input-file: +- Microsoft.Cdn/stable/2016-04-02/cdn.json +``` + +### Tag: package-2015-06 + +These settings apply only when `--tag=package-2015-06` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06' +input-file: +- Microsoft.Cdn/stable/2015-06-01/cdn.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-net + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_cdn'] +``` + + +## C# + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) + +## Node + +See configuration in [readme.node.md](./readme.node.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v2.1/examples/SuccessfulEntitiesRequest.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v2.1/examples/SuccessfulEntitiesRequest.json index 9613f4a622c7..9998306b7111 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v2.1/examples/SuccessfulEntitiesRequest.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v2.1/examples/SuccessfulEntitiesRequest.json @@ -1,111 +1,111 @@ -{ - "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": "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", - "type": "Organization" - }, - { - "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" - } - ] - }, - { - "id": "2", - "entities": [ - { - "name": "1975", - "matches": [ - { - "text": "1975", - "offset": 3, - "length": 4 - } - ], - "type": "DateTime", - "subType": "DateRange" - }, - { - "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", - "type": "Person" - }, - { - "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", - "type": "Person" - } - ] - } - ], - "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": "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", + "type": "Organization" + }, + { + "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" + } + ] + }, + { + "id": "2", + "entities": [ + { + "name": "1975", + "matches": [ + { + "text": "1975", + "offset": 3, + "length": 4 + } + ], + "type": "DateTime", + "subType": "DateRange" + }, + { + "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", + "type": "Person" + }, + { + "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", + "type": "Person" + } + ] + } + ], + "errors": [] + } + } + } +} diff --git a/specification/cognitiveservices/resource-manager/readme.md b/specification/cognitiveservices/resource-manager/readme.md index b7231ef1800c..41faceaf726c 100644 --- a/specification/cognitiveservices/resource-manager/readme.md +++ b/specification/cognitiveservices/resource-manager/readme.md @@ -1,141 +1,141 @@ -# CognitiveServices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for CognitiveServices. - -# Notice -Microsoft will use data you send to Bing Search Services or the Translator Speech API to improve Microsoft products and services. Where you send personal data to these Cognitive Services, you are responsible for obtaining sufficient consent from the data subjects. The General Privacy and Security Terms in the Online Services Terms do not apply to these Cognitive Services. Please refer to the Microsoft Cognitive Services section in the [Online Services Terms](https://www.microsoft.com/en-us/Licensing/product-licensing/products.aspx) for details. Microsoft offers policy controls that may be used to [disable new Cognitive Services deployments](https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account). - ---- -## Getting Started -To build the SDK for CognitiveServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the CognitiveServices API. - -``` yaml -openapi-type: arm -tag: package-2017-04 -``` - - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json -``` - -### Tag: package-2016-02-preview - -These settings apply only when `--tag=package-2016-02-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2016-02-preview' -input-file: -- Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_cognitive_services'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.CognitiveServices - output-folder: $(csharp-sdks-folder)/CognitiveServices/management/Management.CognitiveServices/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.cognitiveservices -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cognitiveservices -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-04 - - tag: package-2016-02-preview -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.cognitiveservices.v2017_04_18 - output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/resource-manager/v2017_04_18 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-02-preview and java - -These settings apply only when `--tag=package-2016-02-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-02-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.cognitiveservices.v2016_02_01_preview - output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/resource-manager/v2016_02_01_preview -regenerate-manager: true -generate-interface: true -``` - - +# CognitiveServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for CognitiveServices. + +# Notice +Microsoft will use data you send to Bing Search Services or the Translator Speech API to improve Microsoft products and services. Where you send personal data to these Cognitive Services, you are responsible for obtaining sufficient consent from the data subjects. The General Privacy and Security Terms in the Online Services Terms do not apply to these Cognitive Services. Please refer to the Microsoft Cognitive Services section in the [Online Services Terms](https://www.microsoft.com/en-us/Licensing/product-licensing/products.aspx) for details. Microsoft offers policy controls that may be used to [disable new Cognitive Services deployments](https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account). + +--- +## Getting Started +To build the SDK for CognitiveServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the CognitiveServices API. + +``` yaml +openapi-type: arm +tag: package-2017-04 +``` + + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json +``` + +### Tag: package-2016-02-preview + +These settings apply only when `--tag=package-2016-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2016-02-preview' +input-file: +- Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_cognitive_services'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.CognitiveServices + output-folder: $(csharp-sdks-folder)/CognitiveServices/management/Management.CognitiveServices/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.cognitiveservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cognitiveservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-04 + - tag: package-2016-02-preview +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.cognitiveservices.v2017_04_18 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/resource-manager/v2017_04_18 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-02-preview and java + +These settings apply only when `--tag=package-2016-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.cognitiveservices.v2016_02_01_preview + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/resource-manager/v2016_02_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/commerce/resource-manager/readme.md b/specification/commerce/resource-manager/readme.md index bec772b597ed..0c401d1a0b55 100644 --- a/specification/commerce/resource-manager/readme.md +++ b/specification/commerce/resource-manager/readme.md @@ -1,129 +1,129 @@ -# Commerce - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Commerce. - - - ---- -## Getting Started -To build the SDK for Commerce, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Commerce API. - -``` yaml -openapi-type: arm -tag: package-2015-06-preview -``` - - -### Tag: package-2015-06-preview - -These settings apply only when `--tag=package-2015-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-06-preview' -input-file: -- Microsoft.Commerce/preview/2015-06-01-preview/commerce.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_commerce'] -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.commerce - package-name: azure-mgmt-commerce - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-commerce/azure/mgmt/commerce -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-commerce -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.commerce -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-commerce -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-06-preview -``` - -### Tag: package-2015-06-preview and java - -These settings apply only when `--tag=package-2015-06-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-06-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.commerce.v2015_06_01_preview - output-folder: $(azure-libraries-for-java-folder)/commerce/resource-manager/v2015_06_01_preview -regenerate-manager: true -generate-interface: true -``` - - +# Commerce + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Commerce. + + + +--- +## Getting Started +To build the SDK for Commerce, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Commerce API. + +``` yaml +openapi-type: arm +tag: package-2015-06-preview +``` + + +### Tag: package-2015-06-preview + +These settings apply only when `--tag=package-2015-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06-preview' +input-file: +- Microsoft.Commerce/preview/2015-06-01-preview/commerce.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_commerce'] +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.commerce + package-name: azure-mgmt-commerce + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-commerce/azure/mgmt/commerce +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-commerce +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.commerce +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-commerce +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-06-preview +``` + +### Tag: package-2015-06-preview and java + +These settings apply only when `--tag=package-2015-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.commerce.v2015_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/commerce/resource-manager/v2015_06_01_preview +regenerate-manager: true +generate-interface: true +``` + + 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/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/containerregistry/resource-manager/readme.md b/specification/containerregistry/resource-manager/readme.md index 044cd903ae01..81572079fa6c 100644 --- a/specification/containerregistry/resource-manager/readme.md +++ b/specification/containerregistry/resource-manager/readme.md @@ -1,238 +1,238 @@ -# ContainerRegistry - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for ContainerRegistry. - - - ---- -## Getting Started -To build the SDK for ContainerRegistry, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the ContainerRegistry API. - -``` yaml -openapi-type: arm -tag: package-2018-09 -``` - -### Tag: package-2018-09 - -These settings apply only when `--tag=package-2018-09` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09' -input-file: -- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json -- Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json -``` - -### Tag: package-2018-02-preview - -These settings apply only when `--tag=package-2018-02-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-02-preview' -input-file: -- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json -- Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json -``` - -### Tag: package-2017-10 - -These settings apply only when `--tag=package-2017-10` is specified on the command line. - -``` yaml $(tag) == 'package-2017-10' -input-file: -- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json -``` - -### Tag: package-2017-06-preview - -These settings apply only when `--tag=package-2017-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-06-preview' -input-file: -- Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json -``` - -### Tag: package-2017-03 - -These settings apply only when `--tag=package-2017-03` is specified on the command line. - -``` yaml $(tag) == 'package-2017-03' -input-file: -- Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json -``` - -### Tag: package-2016-06-preview - -These settings apply only when `--tag=package-2016-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2016-06-preview' -input-file: -- Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-containerregistry - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_registry'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # stop the simplifier from making Task conflict: - skip-simplifier-on-namespace: - - System.Threading.Tasks - # last generated using AutoRest.1.0.0-Nightly20170212 with commit 3b0b26b4b6e3bc5e7cf3610b0866d310abb5b814 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.ContainerRegistry - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/ContainerRegistry/Management.ContainerRegistry/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.containerregistry -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerregistry -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-09 - - tag: package-2018-02-preview - - tag: package-2017-10 - - tag: package-2017-06-preview - - tag: package-2017-03 - - tag: package-2016-06-preview -``` - -### Tag: package-2018-09 and java - -These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerregistry.v2018_09_01 - output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2018_09_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-02-preview and java - -These settings apply only when `--tag=package-2018-02-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-02-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerregistry.v2018_02_01_preview - output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2018_02_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-10 and java - -These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerregistry.v2017_10_01 - output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_10_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-06-preview and java - -These settings apply only when `--tag=package-2017-06-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-06-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerregistry.v2017_06_01_preview - output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_06_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-03 and java - -These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerregistry.v2017_03_01 - output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_03_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-06-preview and java - -These settings apply only when `--tag=package-2016-06-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-06-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerregistry.v2016_06_27_preview - output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2016_06_27_preview -regenerate-manager: true -generate-interface: true -``` +# ContainerRegistry + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ContainerRegistry. + + + +--- +## Getting Started +To build the SDK for ContainerRegistry, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the ContainerRegistry API. + +``` yaml +openapi-type: arm +tag: package-2018-09 +``` + +### Tag: package-2018-09 + +These settings apply only when `--tag=package-2018-09` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09' +input-file: +- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +- Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json +``` + +### Tag: package-2018-02-preview + +These settings apply only when `--tag=package-2018-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02-preview' +input-file: +- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +- Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json +``` + +### Tag: package-2017-10 + +These settings apply only when `--tag=package-2017-10` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10' +input-file: +- Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +``` + +### Tag: package-2017-06-preview + +These settings apply only when `--tag=package-2017-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06-preview' +input-file: +- Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json +``` + +### Tag: package-2017-03 + +These settings apply only when `--tag=package-2017-03` is specified on the command line. + +``` yaml $(tag) == 'package-2017-03' +input-file: +- Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json +``` + +### Tag: package-2016-06-preview + +These settings apply only when `--tag=package-2016-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2016-06-preview' +input-file: +- Microsoft.ContainerRegistry/preview/2016-06-27-preview/containerregistry.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-containerregistry + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_registry'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # stop the simplifier from making Task conflict: + skip-simplifier-on-namespace: + - System.Threading.Tasks + # last generated using AutoRest.1.0.0-Nightly20170212 with commit 3b0b26b4b6e3bc5e7cf3610b0866d310abb5b814 + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.ContainerRegistry + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/ContainerRegistry/Management.ContainerRegistry/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.containerregistry +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerregistry +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09 + - tag: package-2018-02-preview + - tag: package-2017-10 + - tag: package-2017-06-preview + - tag: package-2017-03 + - tag: package-2016-06-preview +``` + +### Tag: package-2018-09 and java + +These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2018_09_01 + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2018_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-02-preview and java + +These settings apply only when `--tag=package-2018-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2018_02_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2018_02_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-06-preview and java + +These settings apply only when `--tag=package-2017-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2017_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_06_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-03 and java + +These settings apply only when `--tag=package-2017-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2017_03_01 + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2017_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-06-preview and java + +These settings apply only when `--tag=package-2016-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerregistry.v2016_06_27_preview + output-folder: $(azure-libraries-for-java-folder)/containerregistry/resource-manager/v2016_06_27_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index 485144ce4239..740a2d0c111c 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -1,172 +1,172 @@ -# Cosmos-DB - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Cosmos-DB. - - - ---- -## Getting Started -To build the SDK for Cosmos-DB, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Cosmos-DB API. - -``` yaml -openapi-type: arm -tag: package-2015-04 -``` - - -### Tag: package-2015-04 - -These settings apply only when `--tag=package-2015-04` is specified on the command line. - -``` yaml $(tag) == 'package-2015-04' -input-file: -- Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json -``` - -## Suppression -``` yaml -directive: - - suppress: TrackedResourceGetOperation - from: cosmos-db.json - where: $.definitions.DatabaseAccountCreateUpdateParameters - reason: The DatabaseAccount request and response resources differ so the DatabaseAccountCreateUpdateParameters must only have a PUT operation - - suppress: TrackedResourcePatchOperation - from: cosmos-db.json - where: $.definitions.DatabaseAccountCreateUpdateParameters - reason: The DatabaseAccount request and response resources differ so the DatabaseAccountCreateUpdateParameters must only have a PUT operation - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.MetricValue.properties._count - reason: The Metrics API has has a property name with a leading underscore character - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.PercentileMetricValue.properties.P10 - reason: The Metrics API has percentile metrics property names with leading capital letters - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.PercentileMetricValue.properties.P25 - reason: The Metrics API has percentile metrics property names with leading capital letters - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.PercentileMetricValue.properties.P50 - reason: The Metrics API has percentile metrics property names with leading capital letters - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.PercentileMetricValue.properties.P75 - reason: The Metrics API has percentile metrics property names with leading capital letters - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.PercentileMetricValue.properties.P90 - reason: The Metrics API has percentile metrics property names with leading capital letters - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.PercentileMetricValue.properties.P95 - reason: The Metrics API has percentile metrics property names with leading capital letters - - suppress: DefinitionsPropertiesNamesCamelCase - from: cosmos-db.json - where: $.definitions.PercentileMetricValue.properties.P99 - reason: The Metrics API has percentile metrics property names with leading capital letters -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.cosmosdb - package-name: azure-mgmt-cosmosdb - package-version: 0.3.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-cosmosdb/azure/mgmt/cosmosdb -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-cosmosdb -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.cosmosdb -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cosmosdb -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-04 -``` - -### Tag: package-2015-04 and java - -These settings apply only when `--tag=package-2015-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.cosmosdb.v2015_04_08 - output-folder: $(azure-libraries-for-java-folder)/cosmosdb/resource-manager/v2015_04_08 -regenerate-manager: true -generate-interface: true -``` - - +# Cosmos-DB + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Cosmos-DB. + + + +--- +## Getting Started +To build the SDK for Cosmos-DB, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Cosmos-DB API. + +``` yaml +openapi-type: arm +tag: package-2015-04 +``` + + +### Tag: package-2015-04 + +These settings apply only when `--tag=package-2015-04` is specified on the command line. + +``` yaml $(tag) == 'package-2015-04' +input-file: +- Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json +``` + +## Suppression +``` yaml +directive: + - suppress: TrackedResourceGetOperation + from: cosmos-db.json + where: $.definitions.DatabaseAccountCreateUpdateParameters + reason: The DatabaseAccount request and response resources differ so the DatabaseAccountCreateUpdateParameters must only have a PUT operation + - suppress: TrackedResourcePatchOperation + from: cosmos-db.json + where: $.definitions.DatabaseAccountCreateUpdateParameters + reason: The DatabaseAccount request and response resources differ so the DatabaseAccountCreateUpdateParameters must only have a PUT operation + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.MetricValue.properties._count + reason: The Metrics API has has a property name with a leading underscore character + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.PercentileMetricValue.properties.P10 + reason: The Metrics API has percentile metrics property names with leading capital letters + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.PercentileMetricValue.properties.P25 + reason: The Metrics API has percentile metrics property names with leading capital letters + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.PercentileMetricValue.properties.P50 + reason: The Metrics API has percentile metrics property names with leading capital letters + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.PercentileMetricValue.properties.P75 + reason: The Metrics API has percentile metrics property names with leading capital letters + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.PercentileMetricValue.properties.P90 + reason: The Metrics API has percentile metrics property names with leading capital letters + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.PercentileMetricValue.properties.P95 + reason: The Metrics API has percentile metrics property names with leading capital letters + - suppress: DefinitionsPropertiesNamesCamelCase + from: cosmos-db.json + where: $.definitions.PercentileMetricValue.properties.P99 + reason: The Metrics API has percentile metrics property names with leading capital letters +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.cosmosdb + package-name: azure-mgmt-cosmosdb + package-version: 0.3.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-cosmosdb/azure/mgmt/cosmosdb +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-cosmosdb +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.cosmosdb +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cosmosdb +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-04 +``` + +### Tag: package-2015-04 and java + +These settings apply only when `--tag=package-2015-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.cosmosdb.v2015_04_08 + output-folder: $(azure-libraries-for-java-folder)/cosmosdb/resource-manager/v2015_04_08 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/customer-insights/resource-manager/readme.md b/specification/customer-insights/resource-manager/readme.md index f3c27bbae17e..9a592a49ff4e 100644 --- a/specification/customer-insights/resource-manager/readme.md +++ b/specification/customer-insights/resource-manager/readme.md @@ -1,139 +1,139 @@ -# CustomerInsights - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for CustomerInsights. - - - ---- -## Getting Started -To build the SDK for CustomerInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the CustomerInsights API. - -``` yaml -openapi-type: arm -tag: package-2017-04 -``` - - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json -``` - - -### Tag: package-2017-01 - -These settings apply only when `--tag=package-2017-01` is specified on the command line. - -``` yaml $(tag) == 'package-2017-01' -input-file: -- Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_customer_insights'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.CustomerInsights - output-folder: $(csharp-sdks-folder)/CustomerInsights/Management.CustomerInsights/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.customerinsights -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-customerinsights -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-01 - - tag: package-2017-04 -``` - -### Tag: package-2017-01 and java - -These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.customerinsights.v2017_01_01 - output-folder: $(azure-libraries-for-java-folder)/customerinsights/resource-manager/v2017_01_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.customerinsights.v2017_04_26 - output-folder: $(azure-libraries-for-java-folder)/customerinsights/resource-manager/v2017_04_26 -regenerate-manager: true -generate-interface: true -``` - - +# CustomerInsights + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for CustomerInsights. + + + +--- +## Getting Started +To build the SDK for CustomerInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the CustomerInsights API. + +``` yaml +openapi-type: arm +tag: package-2017-04 +``` + + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json +``` + + +### Tag: package-2017-01 + +These settings apply only when `--tag=package-2017-01` is specified on the command line. + +``` yaml $(tag) == 'package-2017-01' +input-file: +- Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_customer_insights'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.CustomerInsights + output-folder: $(csharp-sdks-folder)/CustomerInsights/Management.CustomerInsights/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.customerinsights +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-customerinsights +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-01 + - tag: package-2017-04 +``` + +### Tag: package-2017-01 and java + +These settings apply only when `--tag=package-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.customerinsights.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/customerinsights/resource-manager/v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.customerinsights.v2017_04_26 + output-folder: $(azure-libraries-for-java-folder)/customerinsights/resource-manager/v2017_04_26 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/databricks/resource-manager/readme.md b/specification/databricks/resource-manager/readme.md index 2955728e0c8c..9248a3ccab20 100644 --- a/specification/databricks/resource-manager/readme.md +++ b/specification/databricks/resource-manager/readme.md @@ -1,80 +1,80 @@ -# Databricks - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Databricks. - - - ---- - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-04-01 -``` - -### Tag: package-2018-04-01 and java - -These settings apply only when `--tag=package-2018-04-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-04-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.databricks.v2018_04_01 - output-folder: $(azure-libraries-for-java-folder)/databricks/resource-manager/v2018_04_01 -regenerate-manager: true -generate-interface: true -``` - - -## Getting Started -To build the SDK for Databricks, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Databricks API. - -``` yaml -openapi-type: arm -tag: package-2018-04-01 -``` - - -### Tag: package-2018-04-01 - -These settings apply only when `--tag=package-2018-04-01` is specified on the command line. - -``` yaml $(tag) == 'package-2018-04-01' -input-file: -- Microsoft.Databricks/stable/2018-04-01/databricks.json -``` - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## Go - +# Databricks + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Databricks. + + + +--- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-04-01 +``` + +### Tag: package-2018-04-01 and java + +These settings apply only when `--tag=package-2018-04-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-04-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databricks.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/databricks/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true +``` + + +## Getting Started +To build the SDK for Databricks, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Databricks API. + +``` yaml +openapi-type: arm +tag: package-2018-04-01 +``` + + +### Tag: package-2018-04-01 + +These settings apply only when `--tag=package-2018-04-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04-01' +input-file: +- Microsoft.Databricks/stable/2018-04-01/databricks.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## Go + See configuration in [readme.go.md](./readme.go.md) \ 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 74dfdd5a010a..4450974be30d 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 availability.", - "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 availability.", + "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 c7e447b9fc25..2c8eb0db1629 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 Service 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 Service 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 Service 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 Service 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 Service 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 Service dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "XeroObjectDataset" : { - "x-ms-discriminator-value": "XeroObject", - "description": "Xero Service 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 Service 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 Service 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 Service 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 Service 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 Service 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 Service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "XeroObjectDataset" : { + "x-ms-discriminator-value": "XeroObject", + "description": "Xero Service 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 03d537d147fe..dbb3f8502999 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,949 +1,949 @@ -{ - "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" - } - }, - "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" + } + }, + "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 fbd268ade591..952721439015 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,2897 +1,2897 @@ -{ - "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 specified, 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 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)." - } - } - }, - "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 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)." - } - } - }, - "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 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)." - } - } - }, - "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 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)." - } - } - }, - "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 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)." - } - } - }, - "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 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)." - } - } - }, - "XeroSource": { - "description": "A copy activity Xero 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)." - } - } - }, - "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. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", - "type": "object" - }, - "loggingLevel": { - "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", - "type": "object" - }, - "environmentPath": { - "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", - "type": "object" - }, - "executionCredential": { - "description": "The package execution credential.", - "$ref": "#/definitions/SSISExecutionCredential" - }, - "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 (or Expression with resultType string).", - "type": "object" - } - }, - "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" - ] - }, - "SSISExecutionCredential": { - "description": "SSIS package execution credential.", - "type": "object", - "properties": { - "domain": { - "type": "object", - "description": "Domain for windows authentication." - }, - "userName": { - "type": "object", - "description": "UseName for windows authentication." - }, - "password": { - "$ref": "../datafactory.json#/definitions/SecureString", - "description": "Password for windows authentication." - } - }, - "required": [ - "domain", - "userName", - "password" - ] - }, - "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": "Filter 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 specified, 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 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)." + } + } + }, + "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 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)." + } + } + }, + "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 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)." + } + } + }, + "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 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)." + } + } + }, + "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 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)." + } + } + }, + "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 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)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero 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)." + } + } + }, + "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. The value should be \"x86\" or \"x64\". Type: string (or Expression with resultType string).", + "type": "object" + }, + "loggingLevel": { + "description": "The logging level of SSIS package execution. Type: string (or Expression with resultType string).", + "type": "object" + }, + "environmentPath": { + "description": "The environment path to execute the SSIS package. Type: string (or Expression with resultType string).", + "type": "object" + }, + "executionCredential": { + "description": "The package execution credential.", + "$ref": "#/definitions/SSISExecutionCredential" + }, + "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 (or Expression with resultType string).", + "type": "object" + } + }, + "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" + ] + }, + "SSISExecutionCredential": { + "description": "SSIS package execution credential.", + "type": "object", + "properties": { + "domain": { + "type": "object", + "description": "Domain for windows authentication." + }, + "userName": { + "type": "object", + "description": "UseName for windows authentication." + }, + "password": { + "$ref": "../datafactory.json#/definitions/SecureString", + "description": "Password for windows authentication." + } + }, + "required": [ + "domain", + "userName", + "password" + ] + }, + "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": "Filter 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 0acf3d129ef0..a7876492820e 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 occurrence." - }, - "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 every time 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 every time 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 occurrence." + }, + "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 every time 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 every time 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/datafactory/resource-manager/readme.md b/specification/datafactory/resource-manager/readme.md index 2334976564cf..d102c2014d45 100644 --- a/specification/datafactory/resource-manager/readme.md +++ b/specification/datafactory/resource-manager/readme.md @@ -1,262 +1,262 @@ -# Data Factory V2 - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Data Factory V2. - - - ---- -## Getting Started -To build the SDK for Data Factory V2, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - -### Basic Information -These are the global settings for the Data Factory V2 API. - -``` yaml -title: DataFactoryManagementClient -description: The Azure Data Factory V2 management API provides a RESTful set of web services that interact with Azure Data Factory V2 services. -openapi-type: arm -tag: package-2018-06 -``` - -### Tag: package-2018-06 - -These settings apply only when `--tag=package-2018-06` is specified on the command line. - -``` yaml $(tag) == 'package-2018-06' -input-file: -- Microsoft.DataFactory/stable/2018-06-01/datafactory.json -``` - -### Tag: package-2017-09-preview - -These settings apply only when `--tag=package-2017-09-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09-preview' -input-file: -- Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DataFactory - output-folder: $(csharp-sdks-folder)/DataFactory/Management.DataFactory/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.datafactory - package-name: azure-mgmt-datafactory - package-version: 1.0.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-datafactory/azure/mgmt/datafactory -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-datafactory -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.datafactory -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datafactory -``` - -# Validation - - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-09-preview - - tag: package-2018-06 -``` - -### Tag: package-2017-09-preview and java - -These settings apply only when `--tag=package-2017-09-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-09-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.datafactoryv2.v2017_09_01_preview - output-folder: $(azure-libraries-for-java-folder)/datafactoryv2/resource-manager/v2017_09_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-06 and java - -These settings apply only when `--tag=package-2018-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.datafactoryv2.v2018_06_01 - output-folder: $(azure-libraries-for-java-folder)/datafactoryv2/resource-manager/v2018_06_01 -regenerate-manager: true -generate-interface: true -``` - - -## Suppression - -``` yaml -directive: - - suppress: R2001 # AvoidNestedProperties - where: - - $.definitions.IntegrationRuntimeResource.properties.properties - - $.definitions.IntegrationRuntimeStatusResponse.properties.properties - - $.definitions.TriggerResource.properties.properties - - $.definitions.LinkedServiceResource.properties.properties - - $.definitions.TriggerRun.properties.properties - - $.definitions.DatasetResource.properties.properties - - $.properties.properties.LinkedServiceResource.definitions - - $.properties.properties.LinkedServiceResource.definitions - - $.properties.properties.IntegrationRuntimeStatusResponse.definitions - - $.properties.properties.IntegrationRuntimeStatusResponse.definitions - - $.properties.properties.DatasetResource.definitions - - $.properties.properties.DatasetResource.definitions - - $.properties.properties.TriggerResource.definitions - - $.properties.properties.TriggerResource.definitions - from: datafactory.json - reason: - - Flattening does not work well with polymorphic models. - - TriggerResource.properties is an arbitrary dictionary and cannot be flattened. - - suppress: R2018 # XmsEnumValidation - where: - - $.definitions.Expression.properties.type - - $.definitions.SecureString.properties.type - - $.definitions.SecureString.properties.type - - $.definitions.IntegrationRuntimeReference.properties.type - - $.definitions.PipelineReference.properties.type - - $.definitions.DatasetReference.properties.type - - $.definitions.LinkedServiceReference.properties.type - - $.type.properties.DatasetReference.definitions - - $.type.properties.IntegrationRuntimeReference.definitions - - $.type.properties.IntegrationRuntimeReference.definitions - from: datafactory.json - reason: Single-value enums are expressed to force the values to be used for de/serialization but should not be exposed or settable by the a client. - - suppress: R3017 # GuidUsage - where: - - $.definitions.FactoryIdentity.properties.principalId - - $.definitions.FactoryIdentity.properties.tenantId - from: datafactory.json - reason: - - FactoryIdentity.properties.principalId should be a Guid, per MSI integration. - - FactoryIdentity.properties.tenantId should be a Guid, per MSI integration. - - suppress: R3010 # TrackedResourceListByImmediateParent - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}"] - reason: - - Pipeline runs are not listable. The operation PipelineRuns_QueryByFactory serves this purpose. - - suppress: R1003 # ListInOperationName - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].post.operationId - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].paths - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].paths - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].paths - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].paths - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].post.operationId - from: datafactory.json - reason: - - QueryBy API-s are by-design not true list API-s; getting runs requires providing a filter that is part of the request body in a POST call. - - suppress: R2066 # PostOperationIdContainsUrlVerb - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].post.operationId - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].paths - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].post.operationId - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].paths - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].post.operationId - - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].paths - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}"].post.operationId - from: datafactory.json - reason: - - PipelineRuns_QueryByFactory is placed in pipeline runs namespace fpr better user experience. The method name shows the scope. - - ActivityRuns_QueryByPipelineRun is placed in activity runs namespace fpr better user experience. The method name shows the scope. - - CancelPipelineRun API is fixed in our new API version - - suppress: R3018 # EnumInsteadOfBoolean - where: - - $.definitions.OperationMetricDimension.properties.toBeExportedForShoebox - - $.definitions.ActivityPolicy.properties.secureOutput - - $.definitions.SSISPropertyOverride.properties.isSensitive - - $.definitions.ForEachActivityTypeProperties.properties.isSequential - - $.definitions.ExecutePipelineActivityTypeProperties.properties.waitOnCompletion - - $.definitions.SelfHostedIntegrationRuntimeNode.properties.isActiveDispatcher - - $.definitions.IntegrationRuntimeConnectionInfo.properties.isIdentityCertExprired - reason: - - toBeExportedForShoebox is property we send to Azure Monitor which requires the boolean type - - The other properties are simple and self explanatory - -``` +# Data Factory V2 + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Data Factory V2. + + + +--- +## Getting Started +To build the SDK for Data Factory V2, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + +### Basic Information +These are the global settings for the Data Factory V2 API. + +``` yaml +title: DataFactoryManagementClient +description: The Azure Data Factory V2 management API provides a RESTful set of web services that interact with Azure Data Factory V2 services. +openapi-type: arm +tag: package-2018-06 +``` + +### Tag: package-2018-06 + +These settings apply only when `--tag=package-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06' +input-file: +- Microsoft.DataFactory/stable/2018-06-01/datafactory.json +``` + +### Tag: package-2017-09-preview + +These settings apply only when `--tag=package-2017-09-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09-preview' +input-file: +- Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DataFactory + output-folder: $(csharp-sdks-folder)/DataFactory/Management.DataFactory/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.datafactory + package-name: azure-mgmt-datafactory + package-version: 1.0.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-datafactory/azure/mgmt/datafactory +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-datafactory +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.datafactory +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datafactory +``` + +# Validation + + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-09-preview + - tag: package-2018-06 +``` + +### Tag: package-2017-09-preview and java + +These settings apply only when `--tag=package-2017-09-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-09-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datafactoryv2.v2017_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/datafactoryv2/resource-manager/v2017_09_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-06 and java + +These settings apply only when `--tag=package-2018-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datafactoryv2.v2018_06_01 + output-folder: $(azure-libraries-for-java-folder)/datafactoryv2/resource-manager/v2018_06_01 +regenerate-manager: true +generate-interface: true +``` + + +## Suppression + +``` yaml +directive: + - suppress: R2001 # AvoidNestedProperties + where: + - $.definitions.IntegrationRuntimeResource.properties.properties + - $.definitions.IntegrationRuntimeStatusResponse.properties.properties + - $.definitions.TriggerResource.properties.properties + - $.definitions.LinkedServiceResource.properties.properties + - $.definitions.TriggerRun.properties.properties + - $.definitions.DatasetResource.properties.properties + - $.properties.properties.LinkedServiceResource.definitions + - $.properties.properties.LinkedServiceResource.definitions + - $.properties.properties.IntegrationRuntimeStatusResponse.definitions + - $.properties.properties.IntegrationRuntimeStatusResponse.definitions + - $.properties.properties.DatasetResource.definitions + - $.properties.properties.DatasetResource.definitions + - $.properties.properties.TriggerResource.definitions + - $.properties.properties.TriggerResource.definitions + from: datafactory.json + reason: + - Flattening does not work well with polymorphic models. + - TriggerResource.properties is an arbitrary dictionary and cannot be flattened. + - suppress: R2018 # XmsEnumValidation + where: + - $.definitions.Expression.properties.type + - $.definitions.SecureString.properties.type + - $.definitions.SecureString.properties.type + - $.definitions.IntegrationRuntimeReference.properties.type + - $.definitions.PipelineReference.properties.type + - $.definitions.DatasetReference.properties.type + - $.definitions.LinkedServiceReference.properties.type + - $.type.properties.DatasetReference.definitions + - $.type.properties.IntegrationRuntimeReference.definitions + - $.type.properties.IntegrationRuntimeReference.definitions + from: datafactory.json + reason: Single-value enums are expressed to force the values to be used for de/serialization but should not be exposed or settable by the a client. + - suppress: R3017 # GuidUsage + where: + - $.definitions.FactoryIdentity.properties.principalId + - $.definitions.FactoryIdentity.properties.tenantId + from: datafactory.json + reason: + - FactoryIdentity.properties.principalId should be a Guid, per MSI integration. + - FactoryIdentity.properties.tenantId should be a Guid, per MSI integration. + - suppress: R3010 # TrackedResourceListByImmediateParent + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}"] + reason: + - Pipeline runs are not listable. The operation PipelineRuns_QueryByFactory serves this purpose. + - suppress: R1003 # ListInOperationName + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].post.operationId + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].paths + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].paths + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].paths + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].post.operationId + from: datafactory.json + reason: + - QueryBy API-s are by-design not true list API-s; getting runs requires providing a filter that is part of the request body in a POST call. + - suppress: R2066 # PostOperationIdContainsUrlVerb + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].post.operationId + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryPipelineRuns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].post.operationId + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].post.operationId + - $.operationId.post["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns"].paths + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/cancelpipelinerun/{runId}"].post.operationId + from: datafactory.json + reason: + - PipelineRuns_QueryByFactory is placed in pipeline runs namespace fpr better user experience. The method name shows the scope. + - ActivityRuns_QueryByPipelineRun is placed in activity runs namespace fpr better user experience. The method name shows the scope. + - CancelPipelineRun API is fixed in our new API version + - suppress: R3018 # EnumInsteadOfBoolean + where: + - $.definitions.OperationMetricDimension.properties.toBeExportedForShoebox + - $.definitions.ActivityPolicy.properties.secureOutput + - $.definitions.SSISPropertyOverride.properties.isSensitive + - $.definitions.ForEachActivityTypeProperties.properties.isSequential + - $.definitions.ExecutePipelineActivityTypeProperties.properties.waitOnCompletion + - $.definitions.SelfHostedIntegrationRuntimeNode.properties.isActiveDispatcher + - $.definitions.IntegrationRuntimeConnectionInfo.properties.isIdentityCertExprired + reason: + - toBeExportedForShoebox is property we send to Azure Monitor which requires the boolean type + - The other properties are simple and self explanatory + +``` diff --git a/specification/datalake-analytics/data-plane/readme.md b/specification/datalake-analytics/data-plane/readme.md index 52dac03831e4..e644d0bb0bf3 100644 --- a/specification/datalake-analytics/data-plane/readme.md +++ b/specification/datalake-analytics/data-plane/readme.md @@ -1,202 +1,202 @@ -# DataLakeAnalytics - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DataLakeAnalytics. - - - ---- -## Getting Started -To build the SDK for DataLakeAnalytics, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - -### Basic Information -These are the global settings for the DataLakeAnalytics API. - -``` yaml -openapi-type: data-plane -``` - -``` yaml $(package-catalog) -tag: package-catalog-2016-11 -``` - -``` yaml $(package-job) -tag: package-job-2017-09-preview -``` - -### Tag: package-catalog-2016-11 - -These settings apply only when `--tag=package-catalog-2016-11` is specified on the command line. - -``` yaml $(tag) == 'package-catalog-2016-11' -input-file: -- Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json -``` - -### Tag: package-catalog-2015-10-preview - -These settings apply only when `--tag=package-catalog-2015-10-preview` is specified on the command line. - -``` yaml $(tag) == 'package-catalog-2015-10-preview' -input-file: -- Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/catalog.json -``` - -### Tag: package-job-2017-09-preview - -These settings apply only when `--tag=package-job-2017-09-preview` is specified on the command line. - -``` yaml $(tag) == 'package-job-2017-09-preview' -input-file: -- Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json -``` - -### Tag: package-job-2016-11 - -These settings apply only when `--tag=package-job-2016-11` is specified on the command line. - -``` yaml $(tag) == 'package-job-2016-11' -input-file: -- Microsoft.DataLakeAnalytics/stable/2016-11-01/job.json -``` - -### Tag: package-job-2016-03-preview - -These settings apply only when `--tag=package-job-2016-03-preview` is specified on the command line. - -``` yaml $(tag) == 'package-job-2016-03-preview' -input-file: -- Microsoft.DataLakeAnalytics/preview/2016-03-20-preview/job.json -``` - -### Tag: package-job-2015-11-preview - -These settings apply only when `--tag=package-job-2015-11-preview` is specified on the command line. - -``` yaml $(tag) == 'package-job-2015-11-preview' -input-file: -- Microsoft.DataLakeAnalytics/preview/2015-11-01-preview/job.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DataLake.Analytics - output-folder: $(csharp-sdks-folder)/DataLake.Analytics/Management.DataLake.Analytics/Generated -batch: - - package-catalog: true - - package-job: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. - -```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-datalake-analytics - clear-output-folder: true - no-namespace-folders: true -batch: - - tag: package-catalog-2016-11 - - tag: package-job-2017-09-preview -``` - -### Tag: package-job-2017-09-preview and python - -These settings apply only when `--tag=package-job-2017-09-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-job-2017-09-preview' && $(python) -python: - namespace: azure.mgmt.datalake.analytics.job - output-folder: $(python-sdks-folder)/azure-mgmt-datalake-analytics/azure/mgmt/datalake/analytics/job -``` - -### Tag: package-catalog-2016-11 and python - -These settings apply only when `--tag=package-catalog-2016-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-catalog-2016-11' && $(python) -python: - namespace: azure.mgmt.datalake.analytics.catalog - output-folder: $(python-sdks-folder)/azure-mgmt-datalake-analytics/azure/mgmt/datalake/analytics/catalog -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - namespace: com.microsoft.azure.datalake.analytics - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-datalake/analytics -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-job-2017-09-preview - - tag: package-catalog-2016-11 - - tag: package-job-2016-11 - - tag: package-job-2016-03-preview - - tag: package-job-2015-11-preview - - tag: package-catalog-2015-10-preview -``` - -# Validation - -Since this RP has no unique default package, iterate over all of them for validation: - -``` yaml $(validation) -batch: - - package-catalog: true - - package-job: true -``` +# DataLakeAnalytics + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataLakeAnalytics. + + + +--- +## Getting Started +To build the SDK for DataLakeAnalytics, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information +These are the global settings for the DataLakeAnalytics API. + +``` yaml +openapi-type: data-plane +``` + +``` yaml $(package-catalog) +tag: package-catalog-2016-11 +``` + +``` yaml $(package-job) +tag: package-job-2017-09-preview +``` + +### Tag: package-catalog-2016-11 + +These settings apply only when `--tag=package-catalog-2016-11` is specified on the command line. + +``` yaml $(tag) == 'package-catalog-2016-11' +input-file: +- Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json +``` + +### Tag: package-catalog-2015-10-preview + +These settings apply only when `--tag=package-catalog-2015-10-preview` is specified on the command line. + +``` yaml $(tag) == 'package-catalog-2015-10-preview' +input-file: +- Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/catalog.json +``` + +### Tag: package-job-2017-09-preview + +These settings apply only when `--tag=package-job-2017-09-preview` is specified on the command line. + +``` yaml $(tag) == 'package-job-2017-09-preview' +input-file: +- Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json +``` + +### Tag: package-job-2016-11 + +These settings apply only when `--tag=package-job-2016-11` is specified on the command line. + +``` yaml $(tag) == 'package-job-2016-11' +input-file: +- Microsoft.DataLakeAnalytics/stable/2016-11-01/job.json +``` + +### Tag: package-job-2016-03-preview + +These settings apply only when `--tag=package-job-2016-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-job-2016-03-preview' +input-file: +- Microsoft.DataLakeAnalytics/preview/2016-03-20-preview/job.json +``` + +### Tag: package-job-2015-11-preview + +These settings apply only when `--tag=package-job-2015-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-job-2015-11-preview' +input-file: +- Microsoft.DataLakeAnalytics/preview/2015-11-01-preview/job.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DataLake.Analytics + output-folder: $(csharp-sdks-folder)/DataLake.Analytics/Management.DataLake.Analytics/Generated +batch: + - package-catalog: true + - package-job: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-datalake-analytics + clear-output-folder: true + no-namespace-folders: true +batch: + - tag: package-catalog-2016-11 + - tag: package-job-2017-09-preview +``` + +### Tag: package-job-2017-09-preview and python + +These settings apply only when `--tag=package-job-2017-09-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-job-2017-09-preview' && $(python) +python: + namespace: azure.mgmt.datalake.analytics.job + output-folder: $(python-sdks-folder)/azure-mgmt-datalake-analytics/azure/mgmt/datalake/analytics/job +``` + +### Tag: package-catalog-2016-11 and python + +These settings apply only when `--tag=package-catalog-2016-11 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-catalog-2016-11' && $(python) +python: + namespace: azure.mgmt.datalake.analytics.catalog + output-folder: $(python-sdks-folder)/azure-mgmt-datalake-analytics/azure/mgmt/datalake/analytics/catalog +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.datalake.analytics + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-datalake/analytics +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-job-2017-09-preview + - tag: package-catalog-2016-11 + - tag: package-job-2016-11 + - tag: package-job-2016-03-preview + - tag: package-job-2015-11-preview + - tag: package-catalog-2015-10-preview +``` + +# Validation + +Since this RP has no unique default package, iterate over all of them for validation: + +``` yaml $(validation) +batch: + - package-catalog: true + - package-job: true +``` diff --git a/specification/datalake-analytics/resource-manager/readme.md b/specification/datalake-analytics/resource-manager/readme.md index 52298f2e6b9f..489c47d663b9 100644 --- a/specification/datalake-analytics/resource-manager/readme.md +++ b/specification/datalake-analytics/resource-manager/readme.md @@ -1,168 +1,168 @@ -# DataLakeAnalytics - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DataLakeAnalytics. - - - ---- -## Getting Started -To build the SDK for DataLakeAnalytics, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the DataLakeAnalytics API. - -``` yaml -openapi-type: arm -tag: package-2016-11 -``` - - -### Tag: package-2016-11 - -These settings apply only when `--tag=package-2016-11` is specified on the command line. - -``` yaml $(tag) == 'package-2016-11' -input-file: -- Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json -``` - -### Tag: package-2015-10-preview - -These settings apply only when `--tag=package-2015-10-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-10-preview' -input-file: -- Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json -``` - -## Suppression -``` yaml -directive: - - suppress: TrackedResourceGetOperation - reason: This is by design in that we return DataLakeAnalyticsAccountBasic only for Account_List - #where: - # - $.definitions.DataLakeAnalyticsAccountBasic - - - suppress: TrackedResourcePatchOperation - reason: DataLakeAnalyticsAccountBasic is not independent and its purpose is for Account_List only. PATCH is for DataLakeAnalyticsAccount, which will effectively update DataLakeAnalyticsAccountBasic - #where: - # - $.definitions.DataLakeAnalyticsAccountBasic -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_datalake_analytics'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DataLake.Analytics - output-folder: $(csharp-sdks-folder)/DataLake.Analytics/Management.DataLake.Analytics/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-mgmt-datalake-analytics - clear-output-folder: true - no-namespace-folders: true - namespace: azure.mgmt.datalake.analytics.account - output-folder: $(python-sdks-folder)/azure-mgmt-datalake-analytics/azure/mgmt/datalake/analytics/account -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.datalake.analytics -license-header: MICROSOFT_MIT_NO_CODEGEN -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datalake/analytics -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-10-preview - - tag: package-2016-11 -``` - -### Tag: package-2015-10-preview and java - -These settings apply only when `--tag=package-2015-10-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-10-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.datalakeanalytics.v2015_10_01_preview - output-folder: $(azure-libraries-for-java-folder)/datalakeanalytics/resource-manager/v2015_10_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-11 and java - -These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.datalakeanalytics.v2016_11_01 - output-folder: $(azure-libraries-for-java-folder)/datalakeanalytics/resource-manager/v2016_11_01 -regenerate-manager: true -generate-interface: true -``` - - +# DataLakeAnalytics + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataLakeAnalytics. + + + +--- +## Getting Started +To build the SDK for DataLakeAnalytics, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DataLakeAnalytics API. + +``` yaml +openapi-type: arm +tag: package-2016-11 +``` + + +### Tag: package-2016-11 + +These settings apply only when `--tag=package-2016-11` is specified on the command line. + +``` yaml $(tag) == 'package-2016-11' +input-file: +- Microsoft.DataLakeAnalytics/stable/2016-11-01/account.json +``` + +### Tag: package-2015-10-preview + +These settings apply only when `--tag=package-2015-10-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-10-preview' +input-file: +- Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json +``` + +## Suppression +``` yaml +directive: + - suppress: TrackedResourceGetOperation + reason: This is by design in that we return DataLakeAnalyticsAccountBasic only for Account_List + #where: + # - $.definitions.DataLakeAnalyticsAccountBasic + + - suppress: TrackedResourcePatchOperation + reason: DataLakeAnalyticsAccountBasic is not independent and its purpose is for Account_List only. PATCH is for DataLakeAnalyticsAccount, which will effectively update DataLakeAnalyticsAccountBasic + #where: + # - $.definitions.DataLakeAnalyticsAccountBasic +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_datalake_analytics'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DataLake.Analytics + output-folder: $(csharp-sdks-folder)/DataLake.Analytics/Management.DataLake.Analytics/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-datalake-analytics + clear-output-folder: true + no-namespace-folders: true + namespace: azure.mgmt.datalake.analytics.account + output-folder: $(python-sdks-folder)/azure-mgmt-datalake-analytics/azure/mgmt/datalake/analytics/account +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.datalake.analytics +license-header: MICROSOFT_MIT_NO_CODEGEN +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datalake/analytics +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10-preview + - tag: package-2016-11 +``` + +### Tag: package-2015-10-preview and java + +These settings apply only when `--tag=package-2015-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakeanalytics.v2015_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/datalakeanalytics/resource-manager/v2015_10_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-11 and java + +These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakeanalytics.v2016_11_01 + output-folder: $(azure-libraries-for-java-folder)/datalakeanalytics/resource-manager/v2016_11_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/datalake-store/data-plane/readme.md b/specification/datalake-store/data-plane/readme.md index 27b4ea9cb201..e755ae825d69 100644 --- a/specification/datalake-store/data-plane/readme.md +++ b/specification/datalake-store/data-plane/readme.md @@ -1,96 +1,96 @@ -# DataLakeStore - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DataLakeStore. - - - ---- -## Getting Started -To build the SDK for DataLakeStore, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the DataLakeStore API. - -``` yaml -openapi-type: data-plane -tag: package-2016-11 -``` - - -### Tag: package-2016-11 - -These settings apply only when `--tag=package-2016-11` is specified on the command line. - -``` yaml $(tag) == 'package-2016-11' -input-file: -- Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json -``` - -### Tag: package-2015-10-preview - -These settings apply only when `--tag=package-2015-10-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-10-preview' -input-file: -- Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DataLake.Store - output-folder: $(csharp-sdks-folder)/DataLake.Store/Management.DataLake.Store/Generated -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - namespace: com.microsoft.azure.datalake.store - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-datalake/store -``` +# DataLakeStore + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataLakeStore. + + + +--- +## Getting Started +To build the SDK for DataLakeStore, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DataLakeStore API. + +``` yaml +openapi-type: data-plane +tag: package-2016-11 +``` + + +### Tag: package-2016-11 + +These settings apply only when `--tag=package-2016-11` is specified on the command line. + +``` yaml $(tag) == 'package-2016-11' +input-file: +- Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json +``` + +### Tag: package-2015-10-preview + +These settings apply only when `--tag=package-2015-10-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-10-preview' +input-file: +- Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DataLake.Store + output-folder: $(csharp-sdks-folder)/DataLake.Store/Management.DataLake.Store/Generated +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.datalake.store + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-datalake/store +``` diff --git a/specification/datalake-store/resource-manager/readme.md b/specification/datalake-store/resource-manager/readme.md index fec1f3db43bc..2d0474e07c6f 100644 --- a/specification/datalake-store/resource-manager/readme.md +++ b/specification/datalake-store/resource-manager/readme.md @@ -1,180 +1,180 @@ -# DataLakeStore - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DataLakeStore. - - - ---- -## Getting Started -To build the SDK for DataLakeStore, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the DataLakeStore API. - -``` yaml -openapi-type: arm -tag: package-2016-11 -``` - - -### Tag: package-2016-11 - -These settings apply only when `--tag=package-2016-11` is specified on the command line. - -``` yaml $(tag) == 'package-2016-11' -input-file: -- Microsoft.DataLakeStore/stable/2016-11-01/account.json -``` - -### Tag: package-2015-10-preview - -These settings apply only when `--tag=package-2015-10-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-10-preview' -title: DataLakeStoreAccountManagementClient -description: DataLake Store Client -input-file: -- Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json -``` - -## Suppression -``` yaml -directive: - - suppress: TrackedResourceGetOperation - reason: This is by design in that we return DataLakeStoreAccountBasic only for Account_List - #where: - # - $.definitions.DataLakeStoreAccountBasic - - - suppress: TrackedResourcePatchOperation - reason: DataLakeStoreAccountBasic is not independent and its purpose is for Account_List only. PATCH is for DataLakeStoreAccount, which will effectively update DataLakeStoreAccountBasic - #where: - # - $.definitions.DataLakeStoreAccountBasic -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_datalake_store'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DataLake.Store - output-folder: $(csharp-sdks-folder)/DataLake.Store/Management.DataLake.Store/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.datalake.store - package-name: azure-mgmt-datalake-store - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-datalake-store/azure/mgmt/datalake/store -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-datalake-store -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.datalake.store -license-header: MICROSOFT_MIT_NO_CODEGEN -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datalake/store -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-10-preview - - tag: package-2016-11 -``` - -### Tag: package-2015-10-preview and java - -These settings apply only when `--tag=package-2015-10-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-10-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.datalakestore.v2015_10_01_preview - output-folder: $(azure-libraries-for-java-folder)/datalakestore/resource-manager/v2015_10_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-11 and java - -These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.datalakestore.v2016_11_01 - output-folder: $(azure-libraries-for-java-folder)/datalakestore/resource-manager/v2016_11_01 -regenerate-manager: true -generate-interface: true -``` - - +# DataLakeStore + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DataLakeStore. + + + +--- +## Getting Started +To build the SDK for DataLakeStore, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DataLakeStore API. + +``` yaml +openapi-type: arm +tag: package-2016-11 +``` + + +### Tag: package-2016-11 + +These settings apply only when `--tag=package-2016-11` is specified on the command line. + +``` yaml $(tag) == 'package-2016-11' +input-file: +- Microsoft.DataLakeStore/stable/2016-11-01/account.json +``` + +### Tag: package-2015-10-preview + +These settings apply only when `--tag=package-2015-10-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-10-preview' +title: DataLakeStoreAccountManagementClient +description: DataLake Store Client +input-file: +- Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json +``` + +## Suppression +``` yaml +directive: + - suppress: TrackedResourceGetOperation + reason: This is by design in that we return DataLakeStoreAccountBasic only for Account_List + #where: + # - $.definitions.DataLakeStoreAccountBasic + + - suppress: TrackedResourcePatchOperation + reason: DataLakeStoreAccountBasic is not independent and its purpose is for Account_List only. PATCH is for DataLakeStoreAccount, which will effectively update DataLakeStoreAccountBasic + #where: + # - $.definitions.DataLakeStoreAccountBasic +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_datalake_store'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DataLake.Store + output-folder: $(csharp-sdks-folder)/DataLake.Store/Management.DataLake.Store/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.datalake.store + package-name: azure-mgmt-datalake-store + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-datalake-store/azure/mgmt/datalake/store +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-datalake-store +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.datalake.store +license-header: MICROSOFT_MIT_NO_CODEGEN +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datalake/store +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10-preview + - tag: package-2016-11 +``` + +### Tag: package-2015-10-preview and java + +These settings apply only when `--tag=package-2015-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakestore.v2015_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/datalakestore/resource-manager/v2015_10_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-11 and java + +These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.datalakestore.v2016_11_01 + output-folder: $(azure-libraries-for-java-folder)/datalakestore/resource-manager/v2016_11_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json index e77edb89cbb4..fa537c8e23fd 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview", - "artifactSourceInfo": { - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "artifactSourceName": "myArtifactSource", + "api-version": "2018-09-01-preview", + "artifactSourceInfo": { + "type": "Microsoft.DeploymentManager/artifactSources", + "location": "centralus", + "tags": {}, + "properties": { + "sourceType": "AzureStorage", + "authentication": { + "type": "Sas", + "properties": { + "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myArtifactSource", + "type": "Microsoft.DeploymentManager/artifactSources", + "location": "centralus", + "tags": {}, + "properties": { + "sourceType": "AzureStorage", + "authentication": { + "type": "Sas", + "properties": { + "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" + } + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json index 77a3c23b5da6..1e9c567fcfdf 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_createorupdate_artifactroot.json @@ -1,42 +1,42 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview", - "artifactSourceInfo": { - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "artifactRoot": "1.0.0.0", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "artifactSourceName": "myArtifactSource", + "api-version": "2018-09-01-preview", + "artifactSourceInfo": { + "type": "Microsoft.DeploymentManager/artifactSources", + "location": "centralus", + "tags": {}, + "properties": { + "sourceType": "AzureStorage", + "artifactRoot": "1.0.0.0", + "authentication": { + "type": "Sas", + "properties": { + "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myArtifactSource", + "type": "Microsoft.DeploymentManager/artifactSources", + "location": "centralus", + "tags": {}, + "properties": { + "sourceType": "AzureStorage", + "authentication": { + "type": "Sas", + "properties": { + "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" + } + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json index f46b7cd37415..02a8883c88b8 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_delete.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "artifactSourceName": "myArtifactSource", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json index 49b6ff280f62..400d373fdda2 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/artifactsource_get.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "artifactSourceName": "myArtifactSource", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myArtifactSource", - "type": "Microsoft.DeploymentManager/artifactSources", - "location": "centralus", - "tags": {}, - "properties": { - "sourceType": "AzureStorage", - "authentication": { - "type": "Sas", - "properties": { - "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "artifactSourceName": "myArtifactSource", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "myArtifactSource", + "type": "Microsoft.DeploymentManager/artifactSources", + "location": "centralus", + "tags": {}, + "properties": { + "sourceType": "AzureStorage", + "authentication": { + "type": "Sas", + "properties": { + "sasUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" + } + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json index 8f9c7e4eed34..9ee5c60ce0d7 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/operations_get.json @@ -1,165 +1,165 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": [ - { - "name": "Microsoft.DeploymentManager/serviceTopologies/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "View service topology", - "description": "View the properties of a service topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "Update the service topology", - "description": "Create a new topology or update the properties of an existing topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceTopology", - "operation": "Delete service topology", - "description": "Deletes an existing topology." - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "View service in a topology", - "description": "View the properties of a service in a service topology" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "Update the service in a topology", - "description": "Create a new service or update the properties of an existing service" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Service", - "operation": "Delete service", - "description": "Deletes an existing service in a service topology." - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "View service unit", - "description": "View the properties of a service unit" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "Update the service unit", - "description": "Create a new service unit or update the properties of an existing service unit" - } - }, - { - "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ServiceUnit", - "operation": "Delete service unit", - "description": "Deletes an existing service unit." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "View artifact source", - "description": "View the properties of an artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "Update the artifact source", - "description": "Create a new artifact source or updates the properties of an existing artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/artifactSources/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "ArtifactSource", - "operation": "Delete artifact source", - "description": "Deletes an existing artifact source." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/read", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "View rollout", - "description": "View the properties of rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/write", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Create or update a rollout.", - "description": "Create a new rollout or update an existing rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/restart", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Restart a rollout", - "description": "Restarts a failed rollout." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/cancel", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Cancel a rollout", - "description": "Cancel a rollout in progress." - } - }, - { - "name": "Microsoft.DeploymentManager/rollouts/delete", - "display": { - "provider": "Azure Deployment Manager", - "resource": "Rollout", - "operation": "Delete rollout", - "description": "Deletes an existing rollout." - } - } - ] - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.DeploymentManager/serviceTopologies/read", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ServiceTopology", + "operation": "View service topology", + "description": "View the properties of a service topology" + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/write", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ServiceTopology", + "operation": "Update the service topology", + "description": "Create a new topology or update the properties of an existing topology" + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/delete", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ServiceTopology", + "operation": "Delete service topology", + "description": "Deletes an existing topology." + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/services/read", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Service", + "operation": "View service in a topology", + "description": "View the properties of a service in a service topology" + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/services/write", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Service", + "operation": "Update the service in a topology", + "description": "Create a new service or update the properties of an existing service" + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/services/delete", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Service", + "operation": "Delete service", + "description": "Deletes an existing service in a service topology." + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/read", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ServiceUnit", + "operation": "View service unit", + "description": "View the properties of a service unit" + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/write", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ServiceUnit", + "operation": "Update the service unit", + "description": "Create a new service unit or update the properties of an existing service unit" + } + }, + { + "name": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits/delete", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ServiceUnit", + "operation": "Delete service unit", + "description": "Deletes an existing service unit." + } + }, + { + "name": "Microsoft.DeploymentManager/artifactSources/read", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ArtifactSource", + "operation": "View artifact source", + "description": "View the properties of an artifact source." + } + }, + { + "name": "Microsoft.DeploymentManager/artifactSources/write", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ArtifactSource", + "operation": "Update the artifact source", + "description": "Create a new artifact source or updates the properties of an existing artifact source." + } + }, + { + "name": "Microsoft.DeploymentManager/artifactSources/delete", + "display": { + "provider": "Azure Deployment Manager", + "resource": "ArtifactSource", + "operation": "Delete artifact source", + "description": "Deletes an existing artifact source." + } + }, + { + "name": "Microsoft.DeploymentManager/rollouts/read", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Rollout", + "operation": "View rollout", + "description": "View the properties of rollout." + } + }, + { + "name": "Microsoft.DeploymentManager/rollouts/write", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Rollout", + "operation": "Create or update a rollout.", + "description": "Create a new rollout or update an existing rollout." + } + }, + { + "name": "Microsoft.DeploymentManager/rollouts/restart", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Rollout", + "operation": "Restart a rollout", + "description": "Restarts a failed rollout." + } + }, + { + "name": "Microsoft.DeploymentManager/rollouts/cancel", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Rollout", + "operation": "Cancel a rollout", + "description": "Cancel a rollout in progress." + } + }, + { + "name": "Microsoft.DeploymentManager/rollouts/delete", + "display": { + "provider": "Azure Deployment Manager", + "resource": "Rollout", + "operation": "Delete rollout", + "description": "Deletes an existing rollout." + } + } + ] + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json index fdabf8c18f10..834710a4229b 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_createorupdate.json @@ -1,123 +1,123 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview", - "rolloutRequest": { - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - }, - "responses": { - "201": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "rolloutName": "myRollout", + "api-version": "2018-09-01-preview", + "rolloutRequest": { + "type": "Microsoft.DeploymentManager/rollouts", + "location": "centralus", + "tags": {}, + "identity": { + "type": "userAssigned", + "identityIds": [ + "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" + ] + }, + "properties": { + "buildVersion": "1.0.0.1", + "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", + "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", + "stepGroups": [ + { + "name": "FirstRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" + } + ] + }, + { + "name": "SecondRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" + } + ], + "dependsOnStepGroups": [ + "FirstRegion" + ] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "myRollout", + "type": "Microsoft.DeploymentManager/rollouts", + "location": "centralus", + "tags": {}, + "identity": { + "type": "userAssigned", + "identityIds": [ + "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" + ] + }, + "properties": { + "buildVersion": "1.0.0.1", + "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", + "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", + "stepGroups": [ + { + "name": "FirstRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" + } + ] + }, + { + "name": "SecondRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" + } + ], + "dependsOnStepGroups": [ + "FirstRegion" + ] + } + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json index 04cbc4cb4572..a95ff167b6ac 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_delete.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "rolloutName": "myRollout", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json index c76a9a4e45a6..60058f749e9c 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_get.json @@ -1,124 +1,124 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Running", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ], - "services": [ - { - "name": "myService1", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", - "targetLocation": "centralus", - "serviceUnits": [ - { - "name": "myTopologyUni1", - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "steps": [ - { - "name": "preDeploymentStep1", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "endTime": "2018-08-28T03:35:28.556Z" - } - }, - { - "name": "preDeploymentStep2", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:36:56.386Z", - "endTime": "2018-08-28T03:37:28.556Z" - } - }, - { - "name": "deploy", - "status": "running", - "operationInfo": { - "startTime": "2018-08-28T03:38:56.386Z", - "lastUpdatedTime": "2018-08-28T03:39:28.556Z" - }, - "resourceOperations": [ - { - "resourceName": "keyVaultcentralus", - "operationId": "20FC5A21382DA306", - "resourceType": "Microsoft.KeyVault/vaults", - "provisioningState": "Succeeded", - "statusMessage": "", - "statusCode": "OK" - } - ] - } - ] - } - ] - } - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "rolloutName": "myRollout", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "myRollout", + "type": "Microsoft.DeploymentManager/rollouts", + "location": "centralus", + "tags": {}, + "identity": { + "type": "userAssigned", + "identityIds": [ + "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" + ] + }, + "properties": { + "status": "Running", + "operationInfo": { + "startTime": "2018-08-28T03:33:56.386Z", + "retryAttempt": 0 + }, + "totalRetryAttempts": 0, + "buildVersion": "1.0.0.1", + "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", + "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", + "stepGroups": [ + { + "name": "FirstRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" + } + ] + }, + { + "name": "SecondRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" + } + ], + "dependsOnStepGroups": [ + "FirstRegion" + ] + } + ], + "services": [ + { + "name": "myService1", + "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", + "targetLocation": "centralus", + "serviceUnits": [ + { + "name": "myTopologyUni1", + "targetResourceGroup": "myDeploymentResourceGroup", + "deploymentMode": "Incremental", + "steps": [ + { + "name": "preDeploymentStep1", + "status": "succeeded", + "operationInfo": { + "startTime": "2018-08-28T03:33:56.386Z", + "endTime": "2018-08-28T03:35:28.556Z" + } + }, + { + "name": "preDeploymentStep2", + "status": "succeeded", + "operationInfo": { + "startTime": "2018-08-28T03:36:56.386Z", + "endTime": "2018-08-28T03:37:28.556Z" + } + }, + { + "name": "deploy", + "status": "running", + "operationInfo": { + "startTime": "2018-08-28T03:38:56.386Z", + "lastUpdatedTime": "2018-08-28T03:39:28.556Z" + }, + "resourceOperations": [ + { + "resourceName": "keyVaultcentralus", + "operationId": "20FC5A21382DA306", + "resourceType": "Microsoft.KeyVault/vaults", + "provisioningState": "Succeeded", + "statusMessage": "", + "statusCode": "OK" + } + ] + } + ] + } + ] + } + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json index 7298a398d5e8..604ee0c3a97b 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_cancel.json @@ -1,124 +1,124 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Canceling", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 0 - }, - "totalRetryAttempts": 0, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ], - "services": [ - { - "name": "myService1", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", - "targetLocation": "centralus", - "serviceUnits": [ - { - "name": "myTopologyUni1", - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "steps": [ - { - "name": "preDeploymentStep1", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "endTime": "2018-08-28T03:35:28.556Z" - } - }, - { - "name": "preDeploymentStep2", - "status": "succeeded", - "operationInfo": { - "startTime": "2018-08-28T03:36:56.386Z", - "endTime": "2018-08-28T03:37:28.556Z" - } - }, - { - "name": "deploy", - "status": "running", - "operationInfo": { - "startTime": "2018-08-28T03:38:56.386Z", - "lastUpdatedTime": "2018-08-28T03:39:28.556Z" - }, - "resourceOperations": [ - { - "resourceName": "keyVaultcentralus", - "operationId": "20FC5A21382DA306", - "resourceType": "Microsoft.KeyVault/vaults", - "provisioningState": "Succeeded", - "statusMessage": "", - "statusCode": "OK" - } - ] - } - ] - } - ] - } - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "rolloutName": "myRollout", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "myRollout", + "type": "Microsoft.DeploymentManager/rollouts", + "location": "centralus", + "tags": {}, + "identity": { + "type": "userAssigned", + "identityIds": [ + "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" + ] + }, + "properties": { + "status": "Canceling", + "operationInfo": { + "startTime": "2018-08-28T03:33:56.386Z", + "retryAttempt": 0 + }, + "totalRetryAttempts": 0, + "buildVersion": "1.0.0.1", + "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", + "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", + "stepGroups": [ + { + "name": "FirstRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" + } + ] + }, + { + "name": "SecondRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" + } + ], + "dependsOnStepGroups": [ + "FirstRegion" + ] + } + ], + "services": [ + { + "name": "myService1", + "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7", + "targetLocation": "centralus", + "serviceUnits": [ + { + "name": "myTopologyUni1", + "targetResourceGroup": "myDeploymentResourceGroup", + "deploymentMode": "Incremental", + "steps": [ + { + "name": "preDeploymentStep1", + "status": "succeeded", + "operationInfo": { + "startTime": "2018-08-28T03:33:56.386Z", + "endTime": "2018-08-28T03:35:28.556Z" + } + }, + { + "name": "preDeploymentStep2", + "status": "succeeded", + "operationInfo": { + "startTime": "2018-08-28T03:36:56.386Z", + "endTime": "2018-08-28T03:37:28.556Z" + } + }, + { + "name": "deploy", + "status": "running", + "operationInfo": { + "startTime": "2018-08-28T03:38:56.386Z", + "lastUpdatedTime": "2018-08-28T03:39:28.556Z" + }, + "resourceOperations": [ + { + "resourceName": "keyVaultcentralus", + "operationId": "20FC5A21382DA306", + "resourceType": "Microsoft.KeyVault/vaults", + "provisioningState": "Succeeded", + "statusMessage": "", + "statusCode": "OK" + } + ] + } + ] + } + ] + } + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json index 508a20f8b5ad..2e55939395c6 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/rollout_post_restart.json @@ -1,75 +1,75 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "rolloutName": "myRollout", - "skipSucceeded": true, - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myRollout", - "type": "Microsoft.DeploymentManager/rollouts", - "location": "centralus", - "tags": {}, - "identity": { - "type": "userAssigned", - "identityIds": [ - "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" - ] - }, - "properties": { - "status": "Running", - "operationInfo": { - "startTime": "2018-08-28T03:33:56.386Z", - "retryAttempt": 1 - }, - "totalRetryAttempts": 1, - "buildVersion": "1.0.0.1", - "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", - "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", - "stepGroups": [ - { - "name": "FirstRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" - } - ] - }, - { - "name": "SecondRegion", - "preDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" - }, - { - "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" - } - ], - "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", - "postDeploymentSteps": [ - { - "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" - } - ], - "dependsOnStepGroups": [ - "FirstRegion" - ] - } - ] - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "rolloutName": "myRollout", + "skipSucceeded": true, + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "myRollout", + "type": "Microsoft.DeploymentManager/rollouts", + "location": "centralus", + "tags": {}, + "identity": { + "type": "userAssigned", + "identityIds": [ + "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userassignedidentities/myuseridentity" + ] + }, + "properties": { + "status": "Running", + "operationInfo": { + "startTime": "2018-08-28T03:33:56.386Z", + "retryAttempt": 1 + }, + "totalRetryAttempts": 1, + "buildVersion": "1.0.0.1", + "artifactSourceId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/artifactSources/myArtifactSource", + "targetServiceTopologyId": "/subscriptions/caac1590-e859-444f-a9e0-62091c0f5929/resourceGroups/myResourceGroup/Microsoft.DeploymentManager/serviceTopologies/myTopology", + "stepGroups": [ + { + "name": "FirstRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep1" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep2" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit1'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep1" + } + ] + }, + { + "name": "SecondRegion", + "preDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep3" + }, + { + "stepId": "Microsoft.DeploymentManager/steps/preDeployStep4" + } + ], + "deploymentTargetId": "Microsoft.DeploymentManager/serviceTopologies/myTopology/services/myService/serviceUnits/myServiceUnit2'", + "postDeploymentSteps": [ + { + "stepId": "Microsoft.DeploymentManager/steps/postDeployStep5" + } + ], + "dependsOnStepGroups": [ + "FirstRegion" + ] + } + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json index 854b90f3acf4..7e29c8e474dc 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_createorupdate.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2018-09-01-preview", - "serviceInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - }, - "responses": { - "201": { - "body": { - "name": "myService", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "serviceName": "myService", + "api-version": "2018-09-01-preview", + "serviceInfo": { + "type": "Microsoft.DeploymentManager/serviceTopologies/services", + "location": "centralus", + "tags": {}, + "properties": { + "targetLocation": "centralus", + "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" + } + } + }, + "responses": { + "201": { + "body": { + "name": "myService", + "type": "Microsoft.DeploymentManager/serviceTopologies/services", + "location": "centralus", + "tags": {}, + "properties": { + "targetLocation": "centralus", + "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json index dc1ef4bb7026..cc5f0520ecce 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_delete.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "serviceName": "myService", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json index 7498d57ed7ef..bcfc0afc2790 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/service_get.json @@ -1,23 +1,23 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myService", - "type": "Microsoft.DeploymentManager/serviceTopologies/services", - "location": "centralus", - "tags": {}, - "properties": { - "targetLocation": "centralus", - "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "serviceName": "myService", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "myService", + "type": "Microsoft.DeploymentManager/serviceTopologies/services", + "location": "centralus", + "tags": {}, + "properties": { + "targetLocation": "centralus", + "targetSubscriptionId": "600c95c5-3ee5-44fe-b190-ca38a19adcd7" + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json index e2a732a8a746..04601e9dcd6c 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview", - "serviceTopologyInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - }, - "responses": { - "201": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "api-version": "2018-09-01-preview", + "serviceTopologyInfo": { + "type": "Microsoft.DeploymentManager/serviceTopologies", + "location": "centralus", + "tags": {}, + "properties": { + "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" + } + } + }, + "responses": { + "201": { + "body": { + "name": "myTopology", + "type": "Microsoft.DeploymentManager/serviceTopologies", + "location": "centralus", + "tags": {}, + "properties": { + "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json index bfdf73576840..1668c2fa1be6 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_createorupdate_noartifactsource.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview", - "serviceTopologyInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - } - } - }, - "responses": { - "201": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "api-version": "2018-09-01-preview", + "serviceTopologyInfo": { + "type": "Microsoft.DeploymentManager/serviceTopologies", + "location": "centralus", + "tags": {}, + "properties": { + } + } + }, + "responses": { + "201": { + "body": { + "name": "myTopology", + "type": "Microsoft.DeploymentManager/serviceTopologies", + "location": "centralus", + "tags": {}, + "properties": { + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json index e2d8ac981315..8a2b35ec1a4f 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_delete.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json index 8823cc8f1276..1d941924bceb 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/servicetopology_get.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myTopology", - "type": "Microsoft.DeploymentManager/serviceTopologies", - "location": "centralus", - "tags": {}, - "properties": { - "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "myTopology", + "type": "Microsoft.DeploymentManager/serviceTopologies", + "location": "centralus", + "tags": {}, + "properties": { + "artifactSourceId": "Microsoft.DeploymentManager/artifactSources/myArtifactSource" + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json index dbe2e7243e16..24d43be1a856 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview", - "serviceUnitInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "serviceName": "myService", + "serviceUnitName": "myServiceUnit", + "api-version": "2018-09-01-preview", + "serviceUnitInfo": { + "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", + "location": "centralus", + "tags": {}, + "properties": { + "targetResourceGroup": "myDeploymentResourceGroup", + "deploymentMode": "Incremental", + "artifacts": { + "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", + "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myServiceUnit", + "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", + "location": "centralus", + "tags": {}, + "properties": { + "targetResourceGroup": "myDeploymentResourceGroup", + "deploymentMode": "Incremental", + "artifacts": { + "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", + "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json index 35f712ea1724..fb5991eabd27 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_createorupdate_noartifactsource.json @@ -1,41 +1,41 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview", - "serviceUnitInfo": { - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", - "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", - "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "serviceName": "myService", + "serviceUnitName": "myServiceUnit", + "api-version": "2018-09-01-preview", + "serviceUnitInfo": { + "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", + "location": "centralus", + "tags": {}, + "properties": { + "targetResourceGroup": "myDeploymentResourceGroup", + "deploymentMode": "Incremental", + "artifacts": { + "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", + "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myServiceUnit", + "type": "Microsoft.DeploymentManager/serviceTopologies/services/serviceUnits", + "location": "centralus", + "tags": {}, + "properties": { + "targetResourceGroup": "myDeploymentResourceGroup", + "deploymentMode": "Incremental", + "artifacts": { + "templateUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/templates/myTopologyUnit.template.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D", + "parametersUri": "https://mystorageaccount.blob.core.windows.net/myartifactsource/parameter/myTopologyUnit.parameters.json?st=2018-07-07T14%3A10%3A00Z&se=2019-12-31T15%3A10%3A00Z&sp=rl&sv=2017-04-17&sr=c&sig=Yh2SoJ1NhhLRwCLln7de%2Fkabcdefghijklmno5sWEIk%3D" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json index 3f7cb46b7e68..0a3aa3e33d04 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_delete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "serviceName": "myService", + "serviceUnitName": "myServiceUnit", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json index 46a11591ef9b..62e125403fbc 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/serviceunit_get.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "serviceTopologyName": "myTopology", - "serviceName": "myService", - "serviceUnitName": "myServiceUnit", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "myServiceUnit", - "type": "Microsoft.DeploymentManager/servicetopologies/services/serviceunits", - "location": "centralus", - "tags": {}, - "properties": { - "targetResourceGroup": "myDeploymentResourceGroup", - "deploymentMode": "Incremental", - "artifacts": { - "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", - "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "serviceTopologyName": "myTopology", + "serviceName": "myService", + "serviceUnitName": "myServiceUnit", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "myServiceUnit", + "type": "Microsoft.DeploymentManager/servicetopologies/services/serviceunits", + "location": "centralus", + "tags": {}, + "properties": { + "targetResourceGroup": "myDeploymentResourceGroup", + "deploymentMode": "Incremental", + "artifacts": { + "templateArtifactSourceRelativePath": "templates/myTopologyUnit.template.json", + "parametersArtifactSourceRelativePath": "parameter/myTopologyUnit.parameters.json" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json index cf0d0165e99f..786d85c933d2 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_createorupdate.json @@ -1,35 +1,35 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "deploymentStep1", - "api-version": "2018-09-01-preview", - "stepInfo": { - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - }, - "responses": { - "201": { - "body": { - "name": "deploymentStep1", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "stepName": "deploymentStep1", + "api-version": "2018-09-01-preview", + "stepInfo": { + "type": "Microsoft.DeploymentManager/steps", + "location": "centralus", + "tags": {}, + "properties": { + "stepType": "Wait", + "attributes": { + "duration": "PT20M" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "deploymentStep1", + "type": "Microsoft.DeploymentManager/steps", + "location": "centralus", + "tags": {}, + "properties": { + "stepType": "Wait", + "attributes": { + "duration": "PT20M" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json index 1c827ae4303f..eec34d8b74de 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_delete.json @@ -1,12 +1,12 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "deploymentStep1", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "stepName": "deploymentStep1", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json index 89903dd8e306..5781eaf246a0 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/examples/step_get.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", - "resourceGroupName": "myResourceGroup", - "stepName": "deploymentStep1", - "api-version": "2018-09-01-preview" - }, - "responses": { - "200": { - "body": { - "name": "deploymentStep1", - "type": "Microsoft.DeploymentManager/steps", - "location": "centralus", - "tags": {}, - "properties": { - "stepType": "Wait", - "attributes": { - "duration": "PT20M" - } - } - } - } - } +{ + "parameters": { + "subscriptionId": "caac1590-e859-444f-a9e0-62091c0f5929", + "resourceGroupName": "myResourceGroup", + "stepName": "deploymentStep1", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "name": "deploymentStep1", + "type": "Microsoft.DeploymentManager/steps", + "location": "centralus", + "tags": {}, + "properties": { + "stepType": "Wait", + "attributes": { + "duration": "PT20M" + } + } + } + } + } } \ No newline at end of file diff --git a/specification/deploymentmanager/resource-manager/readme.md b/specification/deploymentmanager/resource-manager/readme.md index 2c0184ccef33..3645bd2e1d4b 100644 --- a/specification/deploymentmanager/resource-manager/readme.md +++ b/specification/deploymentmanager/resource-manager/readme.md @@ -1,168 +1,168 @@ -# Azure Deployment Manager - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Deployment Manager. - - ---- -## Getting Started -To build the SDK for Deployment Manager, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - -### Basic Information -These are the global settings for the DeploymentManager API. - -``` yaml -openapi-type: arm -tag: package-2018-09-01-preview -``` - -### Suppression - -``` yaml -directive: - - suppress: EnumInsteadOfBoolean - reason: The boolean properties in the specification are actually boolean values in the Deployment Manager application model. - from: deploymentmanager.json - - suppress: TrackedResourceListByImmediateParent - reason: Not available during preview. - - suppress: TrackedResourcePatchOperation - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceListBySubscription - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceListByResourceGroup - reason: Not available at this time. - from: deploymentmanager.json - - suppress: TrackedResourceGetOperation - reason: The rollout resource has a get operation. The request and response types are separated for clarity. - where: $.definitions.RolloutRequest - - suppress: DescriptionAndTitleMissing - reason: Common types warning. - where: $.definitions.Resource - - suppress: AvoidNestedProperties - reason: Nesting had to be avoided to have the autogenerated classes compose the required polymorphic 'properties' property in the StepResource. - where: $.definitions.StepResource.properties.properties -``` - -### Tag: package-2018-09-01-preview - -These settings apply only when `package-2018-09-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09-01-preview' -input-file: -- Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json -``` - ---- -# Code Generation - - -## Swagger to SDK -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_deploymentmanager'] -``` - -## C# -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DeploymentManager - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/DeploymentManager/Management.DeploymentManager/Generated - clear-output-folder: true -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.deploymentmanager - package-name: azure-mgmt-deploymentmanager - package-version: 0.9.0 - clear-output-folder: true - override-client-name: DeploymentManagerClient -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-deploymentmanager/azure/mgmt/deploymentmanager -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-deploymentmanager -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.deploymentmanager -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-deploymentmanager -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-09-01-preview -``` - -### Tag: package-2018-09-01-preview and java - -These settings apply only when `--tag=package-2018-09-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-09-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.deploymentmanager.v2018-09-01-preview - output-folder: $(azure-libraries-for-java-folder)/deploymentmanager/resource-manager/v2018-09-01-preview -regenerate-manager: true -generate-interface: true -``` +# Azure Deployment Manager + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Deployment Manager. + + +--- +## Getting Started +To build the SDK for Deployment Manager, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + +### Basic Information +These are the global settings for the DeploymentManager API. + +``` yaml +openapi-type: arm +tag: package-2018-09-01-preview +``` + +### Suppression + +``` yaml +directive: + - suppress: EnumInsteadOfBoolean + reason: The boolean properties in the specification are actually boolean values in the Deployment Manager application model. + from: deploymentmanager.json + - suppress: TrackedResourceListByImmediateParent + reason: Not available during preview. + - suppress: TrackedResourcePatchOperation + reason: Not available at this time. + from: deploymentmanager.json + - suppress: TrackedResourceListBySubscription + reason: Not available at this time. + from: deploymentmanager.json + - suppress: TrackedResourceListByResourceGroup + reason: Not available at this time. + from: deploymentmanager.json + - suppress: TrackedResourceGetOperation + reason: The rollout resource has a get operation. The request and response types are separated for clarity. + where: $.definitions.RolloutRequest + - suppress: DescriptionAndTitleMissing + reason: Common types warning. + where: $.definitions.Resource + - suppress: AvoidNestedProperties + reason: Nesting had to be avoided to have the autogenerated classes compose the required polymorphic 'properties' property in the StepResource. + where: $.definitions.StepResource.properties.properties +``` + +### Tag: package-2018-09-01-preview + +These settings apply only when `package-2018-09-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-01-preview' +input-file: +- Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json +``` + +--- +# Code Generation + + +## Swagger to SDK +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_deploymentmanager'] +``` + +## C# +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DeploymentManager + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/DeploymentManager/Management.DeploymentManager/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.deploymentmanager + package-name: azure-mgmt-deploymentmanager + package-version: 0.9.0 + clear-output-folder: true + override-client-name: DeploymentManagerClient +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-deploymentmanager/azure/mgmt/deploymentmanager +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-deploymentmanager +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.deploymentmanager +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-deploymentmanager +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09-01-preview +``` + +### Tag: package-2018-09-01-preview and java + +These settings apply only when `--tag=package-2018-09-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-09-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.deploymentmanager.v2018-09-01-preview + output-folder: $(azure-libraries-for-java-folder)/deploymentmanager/resource-manager/v2018-09-01-preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/deploymentmanager/resource-manager/readme.nodejs.md b/specification/deploymentmanager/resource-manager/readme.nodejs.md index 6af432df2d27..1a824f997569 100644 --- a/specification/deploymentmanager/resource-manager/readme.nodejs.md +++ b/specification/deploymentmanager/resource-manager/readme.nodejs.md @@ -1,14 +1,14 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-deploymentmanager - output-folder: $(node-sdks-folder)/lib/services/deploymentmanagerManagement - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-deploymentmanager + output-folder: $(node-sdks-folder)/lib/services/deploymentmanagerManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/deploymentmanager/resource-manager/readme.ruby.md b/specification/deploymentmanager/resource-manager/readme.ruby.md index dafea90e72ce..2ddf1d0f479c 100644 --- a/specification/deploymentmanager/resource-manager/readme.ruby.md +++ b/specification/deploymentmanager/resource-manager/readme.ruby.md @@ -1,27 +1,27 @@ -## Ruby - -These settings apply only when `--ruby` is specified on the command line. - -``` yaml -package-name: azure_mgmt_deploymentmanager -package-version: "0.9.0" -azure-arm: true -``` - -### Ruby multi-api - -``` yaml $(ruby) && $(multiapi) -batch: - - tag: package-2018-09-01-preview -``` - -### Tag: package-2018-09-01-preview and ruby - -These settings apply only when `--tag=package-2018-09-01-preview --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-09-01-preview' && $(ruby) -namespace: "Azure::DeploymentManager::Mgmt::V2018-09-01-preview" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_deploymentmanager/lib -``` - +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_deploymentmanager +package-version: "0.9.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-09-01-preview +``` + +### Tag: package-2018-09-01-preview and ruby + +These settings apply only when `--tag=package-2018-09-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-09-01-preview' && $(ruby) +namespace: "Azure::DeploymentManager::Mgmt::V2018-09-01-preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_deploymentmanager/lib +``` + diff --git a/specification/devspaces/resource-manager/readme.md b/specification/devspaces/resource-manager/readme.md index 4920ccae6b7a..63db9ebec0aa 100644 --- a/specification/devspaces/resource-manager/readme.md +++ b/specification/devspaces/resource-manager/readme.md @@ -1,134 +1,134 @@ -# DevSpaces - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DevSpaces. - - ---- -## Getting Started -To build the SDK for DevSpaces, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the DevSpaces API. - -``` yaml -title: DevSpacesManagementClient -description: Dev Spaces Client -openapi-type: arm -tag: package-2019-01-01-preview -``` - -### Tag: package-2019-01-01-preview - -These settings apply only when `--tag=package-2019-01-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2019-01-01-preview' -input-file: -- Microsoft.DevSpaces/preview/2019-01-01-preview/devspaces.json -``` - -### Tag: package-2018-06-01-preview - -These settings apply only when `--tag=package-2018-06-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-06-01-preview' -input-file: -- Microsoft.DevSpaces/preview/2018-06-01-preview/devspaces.json -``` - - ---- -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-java - - repo: azure-sdk-for-python - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # last generated with AutoRest.1.0.0-Nightly20170126 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DevSpaces - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/DevSpaces/Management.DevSpaces/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.devspaces -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devspaces -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-06-01-preview - - tag: package-2019-01-01-preview -``` - -### Tag: package-2018-06-01-preview and java - -These settings apply only when `--tag=2018-06-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag)=='package-2018-06-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.devspaces.v2018_06_01_preview - output-folder: $(azure-libraries-for-java-folder)/devspaces/resource-manager/v2018_06_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2019-01-01-preview and java - -These settings apply only when `--tag=2019-01-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag)=='package-2019-01-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.devspaces.v2019_01_01_preview - output-folder: $(azure-libraries-for-java-folder)/devspaces/resource-manager/v2019_01_01_preview -regenerate-manager: true -generate-interface: true +# DevSpaces + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DevSpaces. + + +--- +## Getting Started +To build the SDK for DevSpaces, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DevSpaces API. + +``` yaml +title: DevSpacesManagementClient +description: Dev Spaces Client +openapi-type: arm +tag: package-2019-01-01-preview +``` + +### Tag: package-2019-01-01-preview + +These settings apply only when `--tag=package-2019-01-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2019-01-01-preview' +input-file: +- Microsoft.DevSpaces/preview/2019-01-01-preview/devspaces.json +``` + +### Tag: package-2018-06-01-preview + +These settings apply only when `--tag=package-2018-06-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-01-preview' +input-file: +- Microsoft.DevSpaces/preview/2018-06-01-preview/devspaces.json +``` + + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-java + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # last generated with AutoRest.1.0.0-Nightly20170126 + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DevSpaces + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/DevSpaces/Management.DevSpaces/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.devspaces +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devspaces +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-06-01-preview + - tag: package-2019-01-01-preview +``` + +### Tag: package-2018-06-01-preview and java + +These settings apply only when `--tag=2018-06-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2018-06-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devspaces.v2018_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/devspaces/resource-manager/v2018_06_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2019-01-01-preview and java + +These settings apply only when `--tag=2019-01-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2019-01-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devspaces.v2019_01_01_preview + output-folder: $(azure-libraries-for-java-folder)/devspaces/resource-manager/v2019_01_01_preview +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/readme.md b/specification/devtestlabs/resource-manager/readme.md index 5d9e5b5b70ae..b6468fc6565f 100644 --- a/specification/devtestlabs/resource-manager/readme.md +++ b/specification/devtestlabs/resource-manager/readme.md @@ -1,190 +1,190 @@ -# DevTestLab - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DevTestLab. - - - ---- -## Getting Started -To build the SDK for DevTestLab, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the DevTestLab API. - -``` yaml -openapi-type: arm -tag: package-2018-09 -``` - - -### Tag: package-2018-09 - -These settings apply only when `--tag=package-2018-09` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09' -input-file: -- Microsoft.DevTestLab/stable/2018-09-15/DTL.json -``` - -### Tag: package-2016-05 - -These settings apply only when `--tag=package-2016-05` is specified on the command line. - -``` yaml $(tag) == 'package-2016-05' -input-file: -- Microsoft.DevTestLab/stable/2016-05-15/DTL.json -``` - -### Tag: package-2015-05-preview - -These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-05-preview' -input-file: -- Microsoft.DevTestLab/preview/2015-05-21-preview/DTL.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_devtestlabs'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.DevTestLabs - output-folder: $(csharp-sdks-folder)/DevTestLabs/Management.DevTestLabs/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.devtestlabs - package-name: azure-mgmt-devtestlabs - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-devtestlabs/azure/mgmt/devtestlabs -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-devtestlabs -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.devtestlabs -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devtestlabs -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-09 - - tag: package-2016-05 - - tag: package-2015-05-preview -``` - -### Tag: package-2018-09 and java - -These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.devtestlab.v2018_09_15 - output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2018_09_15 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-05 and java - -These settings apply only when `--tag=package-2016-05 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-05' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.devtestlab.v2016_05_15 - output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2016_05_15 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2015-05-preview and java - -These settings apply only when `--tag=package-2015-05-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-05-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.devtestlab.v2015_05_21_preview - output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2015_05_21_preview -regenerate-manager: true -generate-interface: true -``` - - +# DevTestLab + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DevTestLab. + + + +--- +## Getting Started +To build the SDK for DevTestLab, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the DevTestLab API. + +``` yaml +openapi-type: arm +tag: package-2018-09 +``` + + +### Tag: package-2018-09 + +These settings apply only when `--tag=package-2018-09` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09' +input-file: +- Microsoft.DevTestLab/stable/2018-09-15/DTL.json +``` + +### Tag: package-2016-05 + +These settings apply only when `--tag=package-2016-05` is specified on the command line. + +``` yaml $(tag) == 'package-2016-05' +input-file: +- Microsoft.DevTestLab/stable/2016-05-15/DTL.json +``` + +### Tag: package-2015-05-preview + +These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-05-preview' +input-file: +- Microsoft.DevTestLab/preview/2015-05-21-preview/DTL.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_devtestlabs'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.DevTestLabs + output-folder: $(csharp-sdks-folder)/DevTestLabs/Management.DevTestLabs/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.devtestlabs + package-name: azure-mgmt-devtestlabs + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-devtestlabs/azure/mgmt/devtestlabs +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-devtestlabs +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.devtestlabs +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devtestlabs +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09 + - tag: package-2016-05 + - tag: package-2015-05-preview +``` + +### Tag: package-2018-09 and java + +These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devtestlab.v2018_09_15 + output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2018_09_15 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-05 and java + +These settings apply only when `--tag=package-2016-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devtestlab.v2016_05_15 + output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2016_05_15 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-05-preview and java + +These settings apply only when `--tag=package-2015-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devtestlab.v2015_05_21_preview + output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2015_05_21_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/dns/resource-manager/readme.md b/specification/dns/resource-manager/readme.md index f3d4bb4f2c4a..687dde4dc843 100644 --- a/specification/dns/resource-manager/readme.md +++ b/specification/dns/resource-manager/readme.md @@ -1,230 +1,230 @@ -# DNS - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for DNS. - ---- - -## Getting Started - -To build the SDK for DNS, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the DNS API. - -``` yaml -openapi-type: arm -tag: package-2018-05 -``` - - -### Tag: package-2018-05 - -These settings apply only when `--tag=package-2018-05` is specified on the command line. - -```yaml $(tag) == 'package-2018-05' -input-file: - - Microsoft.Network/stable/2018-05-01/dns.json -directive: - - where: - - $.paths - suppress: - - OperationsAPIImplementation - - where: - - $.definitions.RecordSetProperties.properties.TTL - - $.definitions.RecordSetProperties.properties.ARecords - - $.definitions.RecordSetProperties.properties.AAAARecords - - $.definitions.RecordSetProperties.properties.MXRecords - - $.definitions.RecordSetProperties.properties.NSRecords - - $.definitions.RecordSetProperties.properties.PTRRecords - - $.definitions.RecordSetProperties.properties.SRVRecords - - $.definitions.RecordSetProperties.properties.TXTRecords - - $.definitions.RecordSetProperties.properties.CNAMERecord - - $.definitions.RecordSetProperties.properties.SOARecord - - $.definitions.RecordSetUpdateParameters.properties.RecordSet - suppress: - - DefinitionsPropertiesNamesCamelCase -``` -### Tag: package-2018-03-preview - -These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03-preview' -input-file: -- Microsoft.Network/preview/2018-03-01-preview/dns.json -directive: - - where: - - $.paths - suppress: - - OperationsAPIImplementation - - where: - - $.definitions.RecordSetProperties.properties.TTL - - $.definitions.RecordSetProperties.properties.ARecords - - $.definitions.RecordSetProperties.properties.AAAARecords - - $.definitions.RecordSetProperties.properties.MXRecords - - $.definitions.RecordSetProperties.properties.NSRecords - - $.definitions.RecordSetProperties.properties.PTRRecords - - $.definitions.RecordSetProperties.properties.SRVRecords - - $.definitions.RecordSetProperties.properties.TXTRecords - - $.definitions.RecordSetProperties.properties.CNAMERecord - - $.definitions.RecordSetProperties.properties.SOARecord - - $.definitions.RecordSetUpdateParameters.properties.RecordSet - suppress: - - DefinitionsPropertiesNamesCamelCase -``` - -### Tag: package-2017-10 - -These settings apply only when `--tag=package-2017-10` is specified on the command line. - -``` yaml $(tag) == 'package-2017-10' -input-file: -- Microsoft.Network/stable/2017-10-01/dns.json -directive: - - where: - - $.paths - suppress: - - OperationsAPIImplementation - - where: - - $.definitions.RecordSetProperties.properties.TTL - - $.definitions.RecordSetProperties.properties.ARecords - - $.definitions.RecordSetProperties.properties.AAAARecords - - $.definitions.RecordSetProperties.properties.MXRecords - - $.definitions.RecordSetProperties.properties.NSRecords - - $.definitions.RecordSetProperties.properties.PTRRecords - - $.definitions.RecordSetProperties.properties.SRVRecords - - $.definitions.RecordSetProperties.properties.TXTRecords - - $.definitions.RecordSetProperties.properties.CNAMERecord - - $.definitions.RecordSetProperties.properties.SOARecord - - $.definitions.RecordSetUpdateParameters.properties.RecordSet - suppress: - - DefinitionsPropertiesNamesCamelCase -``` - -### Tag: package-2017-09 - -These settings apply only when `--tag=package-2017-09` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09' -input-file: -- Microsoft.Network/stable/2017-09-01/dns.json -``` - -### Tag: package-2016-04 - -These settings apply only when `--tag=package-2016-04` is specified on the command line. - -``` yaml $(tag) == 'package-2016-04' -input-file: -- Microsoft.Network/stable/2016-04-01/dns.json -``` - -### Tag: package-2015-05-preview - -These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-05-preview' -input-file: -- Microsoft.Network/preview/2015-05-04-preview/dns.json -``` - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-dns - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-typescript - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_dns'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Dns - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/Dns/Management.Dns/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.dns -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-dns -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-10 - - tag: package-2016-04 -``` - -### Tag: package-2017-10 and java - -These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.dns.v2017_10_01 - output-folder: $(azure-libraries-for-java-folder)/dns/resource-manager/v2017_10_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-04 and java - -These settings apply only when `--tag=package-2016-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.dns.v2016_04_01 - output-folder: $(azure-libraries-for-java-folder)/dns/resource-manager/v2016_04_01 -regenerate-manager: true -generate-interface: true -``` +# DNS + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for DNS. + +--- + +## Getting Started + +To build the SDK for DNS, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the DNS API. + +``` yaml +openapi-type: arm +tag: package-2018-05 +``` + + +### Tag: package-2018-05 + +These settings apply only when `--tag=package-2018-05` is specified on the command line. + +```yaml $(tag) == 'package-2018-05' +input-file: + - Microsoft.Network/stable/2018-05-01/dns.json +directive: + - where: + - $.paths + suppress: + - OperationsAPIImplementation + - where: + - $.definitions.RecordSetProperties.properties.TTL + - $.definitions.RecordSetProperties.properties.ARecords + - $.definitions.RecordSetProperties.properties.AAAARecords + - $.definitions.RecordSetProperties.properties.MXRecords + - $.definitions.RecordSetProperties.properties.NSRecords + - $.definitions.RecordSetProperties.properties.PTRRecords + - $.definitions.RecordSetProperties.properties.SRVRecords + - $.definitions.RecordSetProperties.properties.TXTRecords + - $.definitions.RecordSetProperties.properties.CNAMERecord + - $.definitions.RecordSetProperties.properties.SOARecord + - $.definitions.RecordSetUpdateParameters.properties.RecordSet + suppress: + - DefinitionsPropertiesNamesCamelCase +``` +### Tag: package-2018-03-preview + +These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-preview' +input-file: +- Microsoft.Network/preview/2018-03-01-preview/dns.json +directive: + - where: + - $.paths + suppress: + - OperationsAPIImplementation + - where: + - $.definitions.RecordSetProperties.properties.TTL + - $.definitions.RecordSetProperties.properties.ARecords + - $.definitions.RecordSetProperties.properties.AAAARecords + - $.definitions.RecordSetProperties.properties.MXRecords + - $.definitions.RecordSetProperties.properties.NSRecords + - $.definitions.RecordSetProperties.properties.PTRRecords + - $.definitions.RecordSetProperties.properties.SRVRecords + - $.definitions.RecordSetProperties.properties.TXTRecords + - $.definitions.RecordSetProperties.properties.CNAMERecord + - $.definitions.RecordSetProperties.properties.SOARecord + - $.definitions.RecordSetUpdateParameters.properties.RecordSet + suppress: + - DefinitionsPropertiesNamesCamelCase +``` + +### Tag: package-2017-10 + +These settings apply only when `--tag=package-2017-10` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10' +input-file: +- Microsoft.Network/stable/2017-10-01/dns.json +directive: + - where: + - $.paths + suppress: + - OperationsAPIImplementation + - where: + - $.definitions.RecordSetProperties.properties.TTL + - $.definitions.RecordSetProperties.properties.ARecords + - $.definitions.RecordSetProperties.properties.AAAARecords + - $.definitions.RecordSetProperties.properties.MXRecords + - $.definitions.RecordSetProperties.properties.NSRecords + - $.definitions.RecordSetProperties.properties.PTRRecords + - $.definitions.RecordSetProperties.properties.SRVRecords + - $.definitions.RecordSetProperties.properties.TXTRecords + - $.definitions.RecordSetProperties.properties.CNAMERecord + - $.definitions.RecordSetProperties.properties.SOARecord + - $.definitions.RecordSetUpdateParameters.properties.RecordSet + suppress: + - DefinitionsPropertiesNamesCamelCase +``` + +### Tag: package-2017-09 + +These settings apply only when `--tag=package-2017-09` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09' +input-file: +- Microsoft.Network/stable/2017-09-01/dns.json +``` + +### Tag: package-2016-04 + +These settings apply only when `--tag=package-2016-04` is specified on the command line. + +``` yaml $(tag) == 'package-2016-04' +input-file: +- Microsoft.Network/stable/2016-04-01/dns.json +``` + +### Tag: package-2015-05-preview + +These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-05-preview' +input-file: +- Microsoft.Network/preview/2015-05-04-preview/dns.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-dns + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-typescript + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_dns'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Dns + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/Dns/Management.Dns/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.dns +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-dns +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-10 + - tag: package-2016-04 +``` + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.dns.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/dns/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-04 and java + +These settings apply only when `--tag=package-2016-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.dns.v2016_04_01 + output-folder: $(azure-libraries-for-java-folder)/dns/resource-manager/v2016_04_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index 3caf43701c28..fb1bc72c87d8 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -1,179 +1,179 @@ -# EventHub - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for EventHub. - - - ---- -## Getting Started -To build the SDK for EventHub, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the EventHub API. - -``` yaml -openapi-type: arm -tag: package-2017-04 -``` - - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.EventHub/stable/2017-04-01/EventHub.json -``` - - -### Tag: package-2015-08 - -These settings apply only when `--tag=package-2015-08` is specified on the command line. - -``` yaml $(tag) == 'package-2015-08' -input-file: -- Microsoft.EventHub/stable/2015-08-01/EventHub.json -``` - - -### Tag: package-2014-09 - -These settings apply only when `--tag=package-2014-09` is specified on the command line. - -``` yaml $(tag) == 'package-2014-09' -input-file: -- Microsoft.EventHub/stable/2014-09-01/EventHub.json -``` - - -### Tag: package-2018-01-preview - -These settings apply only when `--tag=package-2018-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01-preview' -input-file: -- Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_event_hub'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.EventHub - output-folder: $(csharp-sdks-folder)/EventHub/Management.EventHub/Generated - clear-output-folder: true -``` - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.eventhub -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventhub -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-01-preview - - tag: package-2015-08 - - tag: package-2017-04 -``` - -### Tag: package-2018-01-preview and java - -These settings apply only when `--tag=package-2018-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.eventhub.v2018_01_01_preview - output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2018_01_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2015-08 and java - -These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.eventhub.v2015_08_01 - output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2015_08_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.eventhub.v2017_04_01 - output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2017_04_01 -regenerate-manager: true -generate-interface: true -``` - - +# EventHub + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for EventHub. + + + +--- +## Getting Started +To build the SDK for EventHub, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the EventHub API. + +``` yaml +openapi-type: arm +tag: package-2017-04 +``` + + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.EventHub/stable/2017-04-01/EventHub.json +``` + + +### Tag: package-2015-08 + +These settings apply only when `--tag=package-2015-08` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08' +input-file: +- Microsoft.EventHub/stable/2015-08-01/EventHub.json +``` + + +### Tag: package-2014-09 + +These settings apply only when `--tag=package-2014-09` is specified on the command line. + +``` yaml $(tag) == 'package-2014-09' +input-file: +- Microsoft.EventHub/stable/2014-09-01/EventHub.json +``` + + +### Tag: package-2018-01-preview + +These settings apply only when `--tag=package-2018-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-preview' +input-file: +- Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_event_hub'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.EventHub + output-folder: $(csharp-sdks-folder)/EventHub/Management.EventHub/Generated + clear-output-folder: true +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.eventhub +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventhub +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-01-preview + - tag: package-2015-08 + - tag: package-2017-04 +``` + +### Tag: package-2018-01-preview and java + +These settings apply only when `--tag=package-2018-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventhub.v2018_01_01_preview + output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2018_01_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-08 and java + +These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventhub.v2015_08_01 + output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2015_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventhub.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/eventhub/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/graphrbac/data-plane/readme.md b/specification/graphrbac/data-plane/readme.md index c65c065e5dad..8e44b36f2489 100644 --- a/specification/graphrbac/data-plane/readme.md +++ b/specification/graphrbac/data-plane/readme.md @@ -1,136 +1,136 @@ -# GraphRbac - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for GraphRbac. - - - ---- -## Getting Started -To build the SDK for GraphRbac, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the GraphRbac API. - -``` yaml -openapi-type: data-plane -tag: 1.6 -``` - - -### Tag: 1.6 - -These settings apply only when `--tag=1.6` is specified on the command line. - -``` yaml $(tag) == '1.6' -input-file: -- Microsoft.GraphRbac/stable/1.6/graphrbac.json -``` - -## Suppression - -``` yaml -directive: - - suppress: D5001 - reason: this spec never has examples. It is owned by the SDK group and we already have CLI commands testing it - - suppress: R2058 - reason: existing since the spec started - - suppress: R3016 - reason: existing since the spec started -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_graph_rbac'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Graph.RBAC - output-folder: $(csharp-sdks-folder)/Graph.RBAC/Graph.RBAC/Generated - clear-output-folder: true -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.graphrbac - package-name: azure-graphrbac - package-version: 0.52.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-graphrbac/azure/graphrbac -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-graphrbac -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.graphrbac - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-graphrbac -``` +# GraphRbac + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for GraphRbac. + + + +--- +## Getting Started +To build the SDK for GraphRbac, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the GraphRbac API. + +``` yaml +openapi-type: data-plane +tag: 1.6 +``` + + +### Tag: 1.6 + +These settings apply only when `--tag=1.6` is specified on the command line. + +``` yaml $(tag) == '1.6' +input-file: +- Microsoft.GraphRbac/stable/1.6/graphrbac.json +``` + +## Suppression + +``` yaml +directive: + - suppress: D5001 + reason: this spec never has examples. It is owned by the SDK group and we already have CLI commands testing it + - suppress: R2058 + reason: existing since the spec started + - suppress: R3016 + reason: existing since the spec started +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_graph_rbac'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Graph.RBAC + output-folder: $(csharp-sdks-folder)/Graph.RBAC/Graph.RBAC/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.graphrbac + package-name: azure-graphrbac + package-version: 0.52.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-graphrbac/azure/graphrbac +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-graphrbac +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.graphrbac + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-graphrbac +``` diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json index 384ae6859aa0..5ac4202c4b01 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json @@ -1,76 +1,76 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "jobId": "job_1542085634998_0024", - "fields": "*" - }, - "responses": { - "200": { - "status": { - "mapProgress": 1.0, - "reduceProgress": 1.0, - "cleanupProgress": 0.0, - "setupProgress": 0.0, - "runState": 2, - "startTime": 1542088206436, - "queue": "default", - "priority": "NORMAL", - "schedulingInfo": "NA", - "failureInfo": "NA", - "jobACLs": {}, - "jobName": "TempletonControllerJob", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0024_conf.xml", - "finishTime": 1542088277769, - "historyFile": "", - "trackingUrl": "hn1-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:19888/jobhistory/job/job_1542085634998_0024", - "numUsedSlots": 0, - "numReservedSlots": 0, - "usedMem": 0, - "reservedMem": 0, - "neededMem": 0, - "jobPriority": "NORMAL", - "jobID": { - "id": 24, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0024", - "username": "testuser11750", - "state": "SUCCEEDED", - "retired": false, - "jobComplete": true, - "uber": false - }, - "profile": { - "user": "testuser11750", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0024_conf.xml", - "url": null, - "queueName": "default", - "jobName": "TempletonControllerJob", - "jobID": { - "id": 24, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0024" - }, - "id": "job_1542085634998_0024", - "parentId": null, - "percentComplete": null, - "exitValue": 0, - "user": "testuser11750", - "callback": null, - "completed": "done", - "userargs": { - "statusdir": "2018-11-13T05-49-52-4418fce1-e92e-4732-bc12-f2a3b8ef4432", - "file": null, - "enablejobreconnect": null, - "define": [], - "enablelog": "false", - "files": null, - "callback": null, - "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" - }, - "msg": null - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "jobId": "job_1542085634998_0024", + "fields": "*" + }, + "responses": { + "200": { + "status": { + "mapProgress": 1.0, + "reduceProgress": 1.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 2, + "startTime": 1542088206436, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0024_conf.xml", + "finishTime": 1542088277769, + "historyFile": "", + "trackingUrl": "hn1-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:19888/jobhistory/job/job_1542085634998_0024", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 24, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0024", + "username": "testuser11750", + "state": "SUCCEEDED", + "retired": false, + "jobComplete": true, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0024_conf.xml", + "url": null, + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 24, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0024" + }, + "id": "job_1542085634998_0024", + "parentId": null, + "percentComplete": null, + "exitValue": 0, + "user": "testuser11750", + "callback": null, + "completed": "done", + "userargs": { + "statusdir": "2018-11-13T05-49-52-4418fce1-e92e-4732-bc12-f2a3b8ef4432", + "file": null, + "enablejobreconnect": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json index 1cbee0d0b8e0..bfbeb8b9cdd6 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json @@ -1,13 +1,13 @@ -{ - "parameters": { - "appId": "application_1462754318084_0071", - "clusterDnsName": "cluster.azurehdinsight.net" - }, - "responses": { - "200": { - "body": { - "state": "ACCEPTED" - } - } - } +{ + "parameters": { + "appId": "application_1462754318084_0071", + "clusterDnsName": "cluster.azurehdinsight.net" + }, + "responses": { + "200": { + "body": { + "state": "ACCEPTED" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json index a29a26f4a0c0..75d045a4eb62 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json @@ -1,84 +1,84 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "jobId": "job_1542085634998_0007" - }, - "responses": { - "200": { - "status": { - "mapProgress": 0.0, - "reduceProgress": 0.0, - "cleanupProgress": 0.0, - "setupProgress": 0.0, - "runState": 5, - "startTime": 1542087304445, - "queue": "default", - "priority": "NORMAL", - "schedulingInfo": "NA", - "failureInfo": "NA", - "jobACLs": {}, - "jobName": "TempletonControllerJob", - "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0007/job.xml", - "finishTime": 1542087305443, - "historyFile": "", - "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/cluster/app/application_1542085634998_0007", - "numUsedSlots": 0, - "numReservedSlots": 0, - "usedMem": 0, - "reservedMem": 0, - "neededMem": 0, - "jobPriority": "NORMAL", - "jobID": { - "id": 7, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0007", - "username": "testuser11750", - "state": "KILLED", - "retired": false, - "jobComplete": true, - "uber": false - }, - "profile": { - "user": "testuser11750", - "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0007/job.xml", - "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/cluster/app/application_1542085634998_0007", - "queueName": "default", - "jobName": "TempletonControllerJob", - "jobID": { - "id": 7, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0007" - }, - "id": "job_1542085634998_0007", - "parentId": null, - "percentComplete": null, - "exitValue": null, - "user": "testuser11750", - "callback": null, - "completed": null, - "userargs": { - "statusdir": "2018-11-13T05-35-01-6f79af0f-6157-494a-a03e-eabb190a0c10", - "enablejobreconnect": null, - "arg": [ - "10", - "1000" - ], - "define": [ - "mapreduce.map.maxattempts=10", - "mapreduce.reduce.maxattempts=10", - "mapreduce.task.timeout=60000" - ], - "enablelog": "false", - "libjars": null, - "files": null, - "callback": null, - "jar": "/example/jars/hadoop-mapreduce-examples.jar", - "class": "pi" - }, - "msg": null - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "jobId": "job_1542085634998_0007" + }, + "responses": { + "200": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 5, + "startTime": 1542087304445, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0007/job.xml", + "finishTime": 1542087305443, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/cluster/app/application_1542085634998_0007", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 7, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0007", + "username": "testuser11750", + "state": "KILLED", + "retired": false, + "jobComplete": true, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0007/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/cluster/app/application_1542085634998_0007", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 7, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0007" + }, + "id": "job_1542085634998_0007", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "testuser11750", + "callback": null, + "completed": null, + "userargs": { + "statusdir": "2018-11-13T05-35-01-6f79af0f-6157-494a-a03e-eabb190a0c10", + "enablejobreconnect": null, + "arg": [ + "10", + "1000" + ], + "define": [ + "mapreduce.map.maxattempts=10", + "mapreduce.reduce.maxattempts=10", + "mapreduce.task.timeout=60000" + ], + "enablelog": "false", + "libjars": null, + "files": null, + "callback": null, + "jar": "/example/jars/hadoop-mapreduce-examples.jar", + "class": "pi" + }, + "msg": null + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json index cd36507adc1a..b671a1f55e34 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json @@ -1,82 +1,82 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "fields": "*", - "showall": "true" - }, - "responses": { - "200": { - "body": [ - { - "id": "job_1542085634998_0027", - "detail": { - "status": { - "mapProgress": 0.0, - "reduceProgress": 0.0, - "cleanupProgress": 0.0, - "setupProgress": 0.0, - "runState": 4, - "startTime": 1542088296429, - "queue": "default", - "priority": "NORMAL", - "schedulingInfo": "NA", - "failureInfo": "NA", - "jobACLs": {}, - "jobName": "TempletonControllerJob", - "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", - "finishTime": 0, - "historyFile": "", - "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", - "numUsedSlots": 0, - "numReservedSlots": 0, - "usedMem": 0, - "reservedMem": 0, - "neededMem": 0, - "jobPriority": "NORMAL", - "jobID": { - "id": 27, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0027", - "username": "testuser11750", - "state": "PREP", - "retired": false, - "jobComplete": false, - "uber": false - }, - "profile": { - "user": "testuser11750", - "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", - "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", - "queueName": "default", - "jobName": "TempletonControllerJob", - "jobID": { - "id": 27, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0027" - }, - "id": "job_1542085634998_0027", - "parentId": null, - "percentComplete": null, - "exitValue": null, - "user": "testuser11750", - "callback": null, - "completed": null, - "userargs": { - "statusdir": null, - "file": null, - "define": [], - "enablelog": "false", - "files": null, - "callback": null, - "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" - }, - "msg": null - } - } - ] - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "fields": "*", + "showall": "true" + }, + "responses": { + "200": { + "body": [ + { + "id": "job_1542085634998_0027", + "detail": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 4, + "startTime": 1542088296429, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "finishTime": 0, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027", + "username": "testuser11750", + "state": "PREP", + "retired": false, + "jobComplete": false, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027" + }, + "id": "job_1542085634998_0027", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "testuser11750", + "callback": null, + "completed": null, + "userargs": { + "statusdir": null, + "file": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + } + ] + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json index c4fb3acecd14..ed33b6aecb31 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json @@ -1,212 +1,212 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "jobId": "job_1542085634998_0029", - "numrecords": 3, - "fields": "*", - "showall": "true" - }, - "responses": { - "200": { - "body": [ - { - "id": "job_1542085634998_0028", - "detail": { - "status": { - "mapProgress": 0.0, - "reduceProgress": 0.0, - "cleanupProgress": 0.0, - "setupProgress": 1.0, - "runState": 1, - "startTime": 1542088315731, - "queue": "default", - "priority": "NORMAL", - "schedulingInfo": "NA", - "failureInfo": "NA", - "jobACLs": {}, - "jobName": "TempletonControllerJob", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0028/job.xml", - "finishTime": 0, - "historyFile": "", - "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0028/", - "numUsedSlots": 0, - "numReservedSlots": 0, - "usedMem": 0, - "reservedMem": 0, - "neededMem": 0, - "jobPriority": "NORMAL", - "jobID": { - "id": 28, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0028", - "username": "yarn", - "state": "RUNNING", - "retired": false, - "jobComplete": false, - "uber": false - }, - "profile": { - "user": "yarn", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0028/job.xml", - "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0028/", - "queueName": "default", - "jobName": "TempletonControllerJob", - "jobID": { - "id": 28, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0028" - }, - "id": "job_1542085634998_0028", - "parentId": null, - "percentComplete": null, - "exitValue": null, - "user": "yarn", - "callback": null, - "completed": null, - "userargs": { - "statusdir": null, - "file": null, - "define": [], - "enablelog": "false", - "files": null, - "callback": null, - "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" - }, - "msg": null - } - }, - { - "id": "job_1542085634998_0027", - "detail": { - "status": { - "mapProgress": 0.0, - "reduceProgress": 0.0, - "cleanupProgress": 0.0, - "setupProgress": 1.0, - "runState": 1, - "startTime": 1542088307280, - "queue": "default", - "priority": "NORMAL", - "schedulingInfo": "NA", - "failureInfo": "NA", - "jobACLs": {}, - "jobName": "TempletonControllerJob", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", - "finishTime": 0, - "historyFile": "", - "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", - "numUsedSlots": 0, - "numReservedSlots": 0, - "usedMem": 0, - "reservedMem": 0, - "neededMem": 0, - "jobPriority": "NORMAL", - "jobID": { - "id": 27, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0027", - "username": "yarn", - "state": "RUNNING", - "retired": false, - "jobComplete": false, - "uber": false - }, - "profile": { - "user": "yarn", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", - "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", - "queueName": "default", - "jobName": "TempletonControllerJob", - "jobID": { - "id": 27, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0027" - }, - "id": "job_1542085634998_0027", - "parentId": null, - "percentComplete": null, - "exitValue": null, - "user": "yarn", - "callback": null, - "completed": null, - "userargs": { - "statusdir": null, - "file": null, - "define": [], - "enablelog": "false", - "files": null, - "callback": null, - "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" - }, - "msg": null - } - }, - { - "id": "job_1542085634998_0025", - "detail": { - "status": { - "mapProgress": 1.0, - "reduceProgress": 1.0, - "cleanupProgress": 0.0, - "setupProgress": 0.0, - "runState": 2, - "startTime": 1542088225363, - "queue": "default", - "priority": "NORMAL", - "schedulingInfo": "NA", - "failureInfo": "NA", - "jobACLs": {}, - "jobName": "QuasiMonteCarlo", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0025_conf.xml", - "finishTime": 1542088250019, - "historyFile": "", - "trackingUrl": "hn1-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:19888/jobhistory/job/job_1542085634998_0025", - "numUsedSlots": 0, - "numReservedSlots": 0, - "usedMem": 0, - "reservedMem": 0, - "neededMem": 0, - "jobPriority": "NORMAL", - "jobID": { - "id": 25, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0025", - "username": "testuser11750", - "state": "SUCCEEDED", - "retired": false, - "jobComplete": true, - "uber": false - }, - "profile": { - "user": "testuser11750", - "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0025_conf.xml", - "url": null, - "queueName": "default", - "jobName": "QuasiMonteCarlo", - "jobID": { - "id": 25, - "jtIdentifier": "1542085634998" - }, - "jobId": "job_1542085634998_0025" - }, - "id": "job_1542085634998_0025", - "parentId": "job_1542085634998_0023", - "percentComplete": null, - "exitValue": null, - "user": "testuser11750", - "callback": null, - "completed": null, - "userargs": {}, - "msg": null - } - } - ] - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "jobId": "job_1542085634998_0029", + "numrecords": 3, + "fields": "*", + "showall": "true" + }, + "responses": { + "200": { + "body": [ + { + "id": "job_1542085634998_0028", + "detail": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 1.0, + "runState": 1, + "startTime": 1542088315731, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0028/job.xml", + "finishTime": 0, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0028/", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 28, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0028", + "username": "yarn", + "state": "RUNNING", + "retired": false, + "jobComplete": false, + "uber": false + }, + "profile": { + "user": "yarn", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0028/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0028/", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 28, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0028" + }, + "id": "job_1542085634998_0028", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "yarn", + "callback": null, + "completed": null, + "userargs": { + "statusdir": null, + "file": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + }, + { + "id": "job_1542085634998_0027", + "detail": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 1.0, + "runState": 1, + "startTime": 1542088307280, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "finishTime": 0, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027", + "username": "yarn", + "state": "RUNNING", + "retired": false, + "jobComplete": false, + "uber": false + }, + "profile": { + "user": "yarn", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027" + }, + "id": "job_1542085634998_0027", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "yarn", + "callback": null, + "completed": null, + "userargs": { + "statusdir": null, + "file": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + }, + { + "id": "job_1542085634998_0025", + "detail": { + "status": { + "mapProgress": 1.0, + "reduceProgress": 1.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 2, + "startTime": 1542088225363, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "QuasiMonteCarlo", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0025_conf.xml", + "finishTime": 1542088250019, + "historyFile": "", + "trackingUrl": "hn1-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:19888/jobhistory/job/job_1542085634998_0025", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 25, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0025", + "username": "testuser11750", + "state": "SUCCEEDED", + "retired": false, + "jobComplete": true, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0025_conf.xml", + "url": null, + "queueName": "default", + "jobName": "QuasiMonteCarlo", + "jobID": { + "id": 25, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0025" + }, + "id": "job_1542085634998_0025", + "parentId": "job_1542085634998_0023", + "percentComplete": null, + "exitValue": null, + "user": "testuser11750", + "callback": null, + "completed": null, + "userargs": {}, + "msg": null + } + } + ] + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json index d0d4c46469b0..67e0a4fb09f8 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "content": "execute=select%20querydwelltime%2B2%20from%20hivesampletable%20where%20clientid%20%3D%208&statusdir=2018-10-30T10-13-36-30513317-c398-4da0-a98c-57db43750f3a" - }, - "responses": { - "200": { - "body": { - "id": "job_1540456943299_0046" - } - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "execute=select%20querydwelltime%2B2%20from%20hivesampletable%20where%20clientid%20%3D%208&statusdir=2018-10-30T10-13-36-30513317-c398-4da0-a98c-57db43750f3a" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json index 7978851f76d8..bf07eb745226 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "content": "jar=%2Fexample%2Fjars%2Fhadoop-mapreduce-examples.jar&class=pi&arg=10&arg=1000&define=mapreduce.map.maxattempts%3D10&define=mapreduce.reduce.maxattempts%3D10&define=mapreduce.task.timeout%3D60000&statusdir=2018-10-30T10-12-29-595ef52d-583c-4b17-987b-675e4f8eea8f" - }, - "responses": { - "200": { - "body": { - "id": "job_1540456943299_0046" - } - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "jar=%2Fexample%2Fjars%2Fhadoop-mapreduce-examples.jar&class=pi&arg=10&arg=1000&define=mapreduce.map.maxattempts%3D10&define=mapreduce.reduce.maxattempts%3D10&define=mapreduce.task.timeout%3D60000&statusdir=2018-10-30T10-12-29-595ef52d-583c-4b17-987b-675e4f8eea8f" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json index 76519fb78b0e..719b857a2eaf 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "content": "input=%2Fexample%2Fdata%2Fgutenberg%2Fdavinci.txt&output=%2Fexample%2Fdata%2Fgutenberg%2Fwcount%2F3745c39c-0115-4735-a9eb-c57de9a29dcd&mapper=cat&reducer=wc&statusdir=2018-10-30T11-40-44-eb9dc5c1-99dd-4282-9d4a-a77c8ffb6b35" - }, - "responses": { - "200": { - "body": { - "id": "job_1540456943299_0046" - } - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "input=%2Fexample%2Fdata%2Fgutenberg%2Fdavinci.txt&output=%2Fexample%2Fdata%2Fgutenberg%2Fwcount%2F3745c39c-0115-4735-a9eb-c57de9a29dcd&mapper=cat&reducer=wc&statusdir=2018-10-30T11-40-44-eb9dc5c1-99dd-4282-9d4a-a77c8ffb6b35" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json index 9437bf0b8047..2ea426a9975d 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "content": "execute=LOGS%20%3D%20LOAD%20%27wasb%3A%2F%2F%2Fexample%2Fdata%2Fsample.log%27%3BLEVELS%20%3D%20foreach%20LOGS%20generate%20REGEX_EXTRACT%28%240%2C%20%27%28TRACE%7CDEBUG%7CINFO%7CWARN%7CERROR%7CFATAL%29%27%2C%201%29%20%20as%20LOGLEVEL%3BFILTEREDLEVELS%20%3D%20FILTER%20LEVELS%20by%20LOGLEVEL%20is%20not%20null%3BGROUPEDLEVELS%20%3D%20GROUP%20FILTEREDLEVELS%20by%20LOGLEVEL%3BFREQUENCIES%20%3D%20foreach%20GROUPEDLEVELS%20generate%20group%20as%20LOGLEVEL%2C%20COUNT%28FILTEREDLEVELS.LOGLEVEL%29%20as%20COUNT%3BRESULT%20%3D%20order%20FREQUENCIES%20by%20COUNT%20desc%3BDUMP%20RESULT%3B&statusdir=2018-10-30T12-44-24-bd642975-9a89-4480-aea7-3ee1f34016ec" - }, - "responses": { - "200": { - "body": { - "id": "job_1540456943299_0046" - } - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "execute=LOGS%20%3D%20LOAD%20%27wasb%3A%2F%2F%2Fexample%2Fdata%2Fsample.log%27%3BLEVELS%20%3D%20foreach%20LOGS%20generate%20REGEX_EXTRACT%28%240%2C%20%27%28TRACE%7CDEBUG%7CINFO%7CWARN%7CERROR%7CFATAL%29%27%2C%201%29%20%20as%20LOGLEVEL%3BFILTEREDLEVELS%20%3D%20FILTER%20LEVELS%20by%20LOGLEVEL%20is%20not%20null%3BGROUPEDLEVELS%20%3D%20GROUP%20FILTEREDLEVELS%20by%20LOGLEVEL%3BFREQUENCIES%20%3D%20foreach%20GROUPEDLEVELS%20generate%20group%20as%20LOGLEVEL%2C%20COUNT%28FILTEREDLEVELS.LOGLEVEL%29%20as%20COUNT%3BRESULT%20%3D%20order%20FREQUENCIES%20by%20COUNT%20desc%3BDUMP%20RESULT%3B&statusdir=2018-10-30T12-44-24-bd642975-9a89-4480-aea7-3ee1f34016ec" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json index abb6cb1fea23..1a946de36bf9 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", - "content": "command=import%20--connect%20jdbc%3Asqlserver%3A%2F%2Fdongwwahdi.database.windows.net%3A1433%3Bdatabase%3DHdInsightJobTest%3Buser%3Ddongwwaadmin%3Bpassword%3DHDInsight123%21%3B%20--table%20dept%20--warehouse-dir%20%2Fuser%2Fadmin%2Fsqoop%2F25c8b9f9-dbc1-4096-aa42-45f2868ab782%20--hive-import%20-m%201%20--hive-table%20deptd3175062928d4170831ac17d2eefdaeb&statusdir=SqoopStatus" - }, - "responses": { - "200": { - "body": { - "id": "job_1540456943299_0046" - } - } - } +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "command=import%20--connect%20jdbc%3Asqlserver%3A%2F%2Fdongwwahdi.database.windows.net%3A1433%3Bdatabase%3DHdInsightJobTest%3Buser%3Ddongwwaadmin%3Bpassword%3DHDInsight123%21%3B%20--table%20dept%20--warehouse-dir%20%2Fuser%2Fadmin%2Fsqoop%2F25c8b9f9-dbc1-4096-aa42-45f2868ab782%20--hive-import%20-m%201%20--hive-table%20deptd3175062928d4170831ac17d2eefdaeb&statusdir=SqoopStatus" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json index 6af967646105..4c4ef1c8e6bf 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json @@ -1,930 +1,930 @@ -{ - "swagger": "2.0", - "info": { - "title": "HDInsightJobManagementClient", - "description": "The HDInsight Job Client.", - "version": "2018-11-01-preview", - "x-ms-code-generation-settings": { - "internalConstructors": true - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{clusterDnsName}", - "parameters": [ - { - "$ref": "#/parameters/clusterDnsNameParameter" - } - ] - }, - "schemes": [ - "https" - ], - "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": { - "/templeton/v1/jobs/{jobId}": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Job_Get", - "description": "Gets job details from the specified HDInsight cluster.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Gets job details from the specified HDInsight cluster": { - "$ref": "./examples/HDI_Job_Get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "jobId", - "in": "path", - "required": true, - "type": "string", - "description": "The id of the job." - }, - { - "name": "fields", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "*" - ], - "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/JobDetailRootJsonObject" - } - } - } - }, - "delete": { - "tags": [ - "Job" - ], - "operationId": "Job_Kill", - "description": "Initiates cancel on given running job in the specified HDInsight.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Initiates cancel on given running job in the specified HDInsight.": { - "$ref": "./examples/HDI_Job_Kill.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "jobId", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "description": "The id of the job." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/JobDetailRootJsonObject" - } - } - } - } - }, - "/templeton/v1/jobs": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Job_List", - "description": "Gets the list of jobs from the specified HDInsight cluster.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Gets the list of jobs from the specified HDInsight cluster.": { - "$ref": "./examples/HDI_Job_List.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "showall", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "true" - ], - "description": "If showall is set to 'true', the request will return all jobs the user has permission to view, not only the jobs belonging to the user." - }, - { - "name": "fields", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "*" - ], - "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobListJsonObject" - } - } - } - } - } - }, - "/templeton/v1/jobs?op=LISTAFTERID": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Job_ListAfterJobId", - "description": "Gets numrecords Of Jobs after jobid from the specified HDInsight cluster.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Gets numOfJobs after jobId from the specified HDInsight cluster.": { - "$ref": "./examples/HDI_Job_ListAfterJobId.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "jobid", - "in": "query", - "required": false, - "type": "string", - "description": "JobId from where to list jobs." - }, - { - "name": "numrecords", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 1, - "description": "Number of jobs to fetch." - }, - { - "name": "showall", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "true" - ], - "description": "If showall is set to 'true', the request will return all jobs the user has permission to view, not only the jobs belonging to the user." - }, - { - "name": "fields", - "in": "query", - "required": true, - "type": "string", - "enum": [ - "*" - ], - "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/JobListJsonObject" - } - } - } - } - } - }, - "/templeton/v1/hive": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Job_SubmitHiveJob", - "description": "Submits a Hive job to an HDInsight cluster.", - "consumes": [ - "application/text" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Submits a Hive job to an HDInsight cluster.": { - "$ref": "./examples/HDI_Job_SubmitHiveJob.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "content", - "in": "body", - "required": true, - "schema":{ - "type": "object", - "format": "file" - }, - "description": "The content of the Hive job request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/JobSubmissionJsonResponse" - } - } - } - } - }, - "/templeton/v1/mapreduce/jar": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Job_SubmitMapReduceJob", - "description": "Submits a MapReduce job to an HDInsight cluster.", - "consumes": [ - "text/plain" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Submits a MapReduce job to an HDInsight cluster.": { - "$ref": "./examples/HDI_Job_SubmitMapReduceJob.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "content", - "in": "body", - "required": true, - "schema":{ - "type": "object", - "format": "file" - }, - "description": "The content of the MapReduce job request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/JobSubmissionJsonResponse" - } - } - } - } - }, - "/templeton/v1/mapreduce/streaming": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Job_SubmitMapReduceStreamingJob", - "description": "Submits a MapReduce streaming job to an HDInsight cluster.", - "consumes": [ - "text/plain" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Submits a MapReduce streaming job to an HDInsight cluster.": { - "$ref": "./examples/HDI_Job_SubmitMapReduceStreamingJob.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "content", - "in": "body", - "required": true, - "schema":{ - "type": "object", - "format": "file" - }, - "description": "The content of the MapReduce job request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/JobSubmissionJsonResponse" - } - } - } - } - }, - "/templeton/v1/pig": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Job_SubmitPigJob", - "description": "Submits a Pig job to an HDInsight cluster.", - "consumes": [ - "text/plain" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Submits a Pig job to an HDInsight cluster.": { - "$ref": "./examples/HDI_Job_SubmitPigJob.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "content", - "in": "body", - "required": true, - "schema":{ - "type": "object", - "format": "file" - }, - "description": "The content of the Pig job request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/JobSubmissionJsonResponse" - } - } - } - } - }, - "/templeton/v1/sqoop": { - "post": { - "tags": [ - "Job" - ], - "operationId": "Job_SubmitSqoopJob", - "description": "Submits a Sqoop job to an HDInsight cluster.", - "consumes": [ - "text/plain" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Submits a Sqoop job to an HDInsight cluster.": { - "$ref": "./examples/HDI_Job_SubmitSqoopJob.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/UserNameParameter" - }, - { - "name": "content", - "in": "body", - "required": true, - "schema": { - "type": "object", - "format": "file" - }, - "description": "The content of the Sqoop job request." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/JobSubmissionJsonResponse" - } - } - } - } - }, - "/ws/v1/cluster/apps/{appId}/state": { - "get": { - "tags": [ - "Job" - ], - "operationId": "Job_GetAppState", - "description": "Gets application state from the specified HDInsight cluster.", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Gets application state from the specified HDInsight cluster.": { - "$ref": "./examples/HDI_Job_GetAppState.json" - } - }, - "parameters": [ - { - "name": "appId", - "in": "path", - "required": true, - "type": "string", - "description": "The id of the job." - } - ], - "responses": { - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/JobOperationsErrorResponse" - } - }, - "200": { - "description": "OK response definition.", - "schema": { - "$ref": "#/definitions/AppState" - } - } - } - } - } - }, - "definitions": { - "AppState": { - "description": "The State of the application.", - "properties": { - "state": { - "type": "string", - "enum": [ - "NEW", - "NEW_SAVING", - "SUBMITTED", - "ACCEPTED", - "RUNNING", - "FINISHED", - "FINISHING", - "FAILED", - "KILLED" - ], - "x-ms-enum": { - "name": "ApplicationState", - "modelAsString": false - }, - "description": "The State of the application." - } - } - }, - "JobOperationsErrorResponse": { - "description": "Describes the format of Error response.", - "type": "object", - "properties": { - "error": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "JobACLs": { - "description": "The object containing the job ACLs." - }, - "JobDetailRootJsonObject": { - "description": "The object containing the job details.", - "properties": { - "callback": { - "type": "object", - "description": "The callback URL, if any." - }, - "completed": { - "type": "string", - "description": "The string representing completed status, for example 'done'." - }, - "exitValue": { - "type": "integer", - "format": "int32", - "description": "The job's exit value." - }, - "id": { - "type": "string", - "description": "The job ID." - }, - "msg": { - "type": "object", - "description": "The message returned." - }, - "parentId": { - "type": "string", - "description": "The parent job ID." - }, - "percentComplete": { - "type": "string", - "description": "The job completion percentage, for example '75% complete'." - }, - "profile": { - "$ref": "#/definitions/Profile", - "description": "The object containing the job profile information." - }, - "status": { - "$ref": "#/definitions/Status", - "description": "The object containing the job status information." - }, - "user": { - "type": "string", - "description": "The user name of the job creator." - }, - "userargs": { - "$ref": "#/definitions/Userargs", - "description": "The arguments passed in by the user." - } - } - }, - "JobID": { - "description": "The object with the Job ID.", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "description": "The job number." - }, - "jtIdentifier": { - "type": "string", - "description": "The jobTracker identifier." - } - } - }, - "JobListJsonObject": { - "description": "The List Job operation response.", - "properties": { - "detail": { - "$ref": "#/definitions/JobDetailRootJsonObject", - "description": "The detail of the job." - }, - "id": { - "type": "string", - "description": "The Id of the job." - } - } - }, - "JobSubmissionJsonResponse": { - "description": "The job submission json response.", - "properties": { - "id": { - "type": "string", - "description": "The Id of the created job." - } - } - }, - "Profile": { - "description": "The object containing the job profile information.", - "properties": { - "jobFile": { - "type": "string", - "description": "The job configuration file." - }, - "jobId": { - "type": "string", - "description": "The full ID of the job." - }, - "jobID": { - "$ref": "#/definitions/JobID", - "description": "The ID of the job." - }, - "jobName": { - "type": "string", - "description": "The user-specified job name." - }, - "queueName": { - "type": "string", - "description": "The name of the queue to which the job is submitted." - }, - "url": { - "type": "string", - "description": "The link to the web-ui for details of the job." - }, - "user": { - "type": "string", - "description": "The userid of the person who submitted the job." - } - } - }, - "Status": { - "description": "Gets or sets the object containing the job status information.", - "properties": { - "cleanupProgress": { - "type": "number", - "format": "double", - "description": "The progress made on the cleanup." - }, - "failureInfo": { - "type": "string", - "description": "The information about any failures that have occurred." - }, - "finishTime": { - "type": "integer", - "format": "int64", - "description": "The time at which the job completed. It is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00." - }, - "historyFile": { - "type": "string", - "description": "The history file of the job." - }, - "jobACLs": { - "$ref": "#/definitions/JobACLs", - "description": "The ACLs of the job." - }, - "jobComplete": { - "type": "boolean", - "description": "Whether or not the job has completed." - }, - "jobFile": { - "type": "string", - "description": "The job configuration file." - }, - "jobId": { - "type": "string", - "description": "The full ID of the job." - }, - "jobID": { - "$ref": "#/definitions/JobID", - "description": "The ID of the job." - }, - "jobName": { - "type": "string", - "description": "The user-specified job name." - }, - "jobPriority": { - "type": "string", - "description": "The priority of the job." - }, - "mapProgress": { - "type": "number", - "format": "double", - "description": "The progress made on the maps." - }, - "neededMem": { - "type": "integer", - "format": "int64", - "description": "The amount of memory needed for the job." - }, - "numReservedSlots": { - "type": "integer", - "format": "int32", - "description": "The number of slots reserved." - }, - "numUsedSlots": { - "type": "integer", - "format": "int32", - "description": "The number of slots used for the job." - }, - "priority": { - "type": "string", - "description": "The priority of the job." - }, - "queue": { - "type": "string", - "description": "The job queue name." - }, - "reduceProgress": { - "type": "number", - "format": "double", - "description": "The progress made on the reduces." - }, - "reservedMem": { - "type": "integer", - "format": "int64", - "description": "The amount of memory reserved for the job." - }, - "retired": { - "type": "boolean", - "description": "Whether or not the job has been retired. " - }, - "runState": { - "type": "integer", - "format": "int32", - "description": "The current state of the job." - }, - "schedulingInfo": { - "type": "string", - "description": "The information about the scheduling of the job." - }, - "setupProgress": { - "type": "number", - "format": "double", - "description": "The progress made on the setup." - }, - "startTime": { - "type": "integer", - "format": "int64", - "description": "The time at which the job started. It is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00." - }, - "state": { - "type": "string", - "description": "The state of the job." - }, - "trackingUrl": { - "type": "string", - "description": "The link to the web-ui for details of the job." - }, - "uber": { - "type": "boolean", - "description": "Whether job running in uber mode." - }, - "usedMem": { - "type": "integer", - "format": "int64", - "description": "The amount of memory used by the job." - }, - "username": { - "type": "string", - "description": "The userid of the person who submitted the job." - } - } - }, - "Userargs": { - "description": "Gets or sets the object containing the user arguments.", - "properties": { - "arg": { - "type": "array", - "readOnly": true, - "items": { - "type": "string" - }, - "description": "The list of args defined by the user." - }, - "callback": { - "type": "object", - "description": "The callback URL, if any." - }, - "define": { - "type": "array", - "readOnly": true, - "items": { - "type": "string" - }, - "description": "The define properties defined by the user." - }, - "enablelog": { - "type": "string", - "description": "Whether or not the user enabled logs." - }, - "execute": { - "type": "string", - "description": "The query defined by the user." - }, - "file": { - "type": "object", - "description": "The query file provided by the user." - }, - "files": { - "type": "object", - "description": "The files defined by the user." - }, - "jar": { - "type": "string", - "description": "The JAR file provided by the user." - }, - "statusdir": { - "type": "object", - "description": "The status directory defined by the user." - } - } - } - }, - "parameters": { - "clusterDnsNameParameter": { - "name": "clusterDnsName", - "in": "path", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "description": "The cluster dns name against which the job management is to be.", - "x-ms-parameter-location": "client" - }, - "UserNameParameter": { - "name": "user.name", - "in": "query", - "required": true, - "type": "string", - "description": "The user name used for running job.", - "x-ms-parameter-location": "client" - } - } +{ + "swagger": "2.0", + "info": { + "title": "HDInsightJobManagementClient", + "description": "The HDInsight Job Client.", + "version": "2018-11-01-preview", + "x-ms-code-generation-settings": { + "internalConstructors": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{clusterDnsName}", + "parameters": [ + { + "$ref": "#/parameters/clusterDnsNameParameter" + } + ] + }, + "schemes": [ + "https" + ], + "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": { + "/templeton/v1/jobs/{jobId}": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_Get", + "description": "Gets job details from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets job details from the specified HDInsight cluster": { + "$ref": "./examples/HDI_Job_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the job." + }, + { + "name": "fields", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "*" + ], + "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobDetailRootJsonObject" + } + } + } + }, + "delete": { + "tags": [ + "Job" + ], + "operationId": "Job_Kill", + "description": "Initiates cancel on given running job in the specified HDInsight.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Initiates cancel on given running job in the specified HDInsight.": { + "$ref": "./examples/HDI_Job_Kill.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The id of the job." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobDetailRootJsonObject" + } + } + } + } + }, + "/templeton/v1/jobs": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_List", + "description": "Gets the list of jobs from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets the list of jobs from the specified HDInsight cluster.": { + "$ref": "./examples/HDI_Job_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "showall", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "description": "If showall is set to 'true', the request will return all jobs the user has permission to view, not only the jobs belonging to the user." + }, + { + "name": "fields", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "*" + ], + "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobListJsonObject" + } + } + } + } + } + }, + "/templeton/v1/jobs?op=LISTAFTERID": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_ListAfterJobId", + "description": "Gets numrecords Of Jobs after jobid from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets numOfJobs after jobId from the specified HDInsight cluster.": { + "$ref": "./examples/HDI_Job_ListAfterJobId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "jobid", + "in": "query", + "required": false, + "type": "string", + "description": "JobId from where to list jobs." + }, + { + "name": "numrecords", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "Number of jobs to fetch." + }, + { + "name": "showall", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "description": "If showall is set to 'true', the request will return all jobs the user has permission to view, not only the jobs belonging to the user." + }, + { + "name": "fields", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "*" + ], + "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobListJsonObject" + } + } + } + } + } + }, + "/templeton/v1/hive": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitHiveJob", + "description": "Submits a Hive job to an HDInsight cluster.", + "consumes": [ + "application/text" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a Hive job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitHiveJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the Hive job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/mapreduce/jar": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitMapReduceJob", + "description": "Submits a MapReduce job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a MapReduce job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitMapReduceJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the MapReduce job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/mapreduce/streaming": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitMapReduceStreamingJob", + "description": "Submits a MapReduce streaming job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a MapReduce streaming job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitMapReduceStreamingJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the MapReduce job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/pig": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitPigJob", + "description": "Submits a Pig job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a Pig job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitPigJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the Pig job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/sqoop": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitSqoopJob", + "description": "Submits a Sqoop job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a Sqoop job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitSqoopJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema": { + "type": "object", + "format": "file" + }, + "description": "The content of the Sqoop job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/ws/v1/cluster/apps/{appId}/state": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_GetAppState", + "description": "Gets application state from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets application state from the specified HDInsight cluster.": { + "$ref": "./examples/HDI_Job_GetAppState.json" + } + }, + "parameters": [ + { + "name": "appId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the job." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/AppState" + } + } + } + } + } + }, + "definitions": { + "AppState": { + "description": "The State of the application.", + "properties": { + "state": { + "type": "string", + "enum": [ + "NEW", + "NEW_SAVING", + "SUBMITTED", + "ACCEPTED", + "RUNNING", + "FINISHED", + "FINISHING", + "FAILED", + "KILLED" + ], + "x-ms-enum": { + "name": "ApplicationState", + "modelAsString": false + }, + "description": "The State of the application." + } + } + }, + "JobOperationsErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "error": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "JobACLs": { + "description": "The object containing the job ACLs." + }, + "JobDetailRootJsonObject": { + "description": "The object containing the job details.", + "properties": { + "callback": { + "type": "object", + "description": "The callback URL, if any." + }, + "completed": { + "type": "string", + "description": "The string representing completed status, for example 'done'." + }, + "exitValue": { + "type": "integer", + "format": "int32", + "description": "The job's exit value." + }, + "id": { + "type": "string", + "description": "The job ID." + }, + "msg": { + "type": "object", + "description": "The message returned." + }, + "parentId": { + "type": "string", + "description": "The parent job ID." + }, + "percentComplete": { + "type": "string", + "description": "The job completion percentage, for example '75% complete'." + }, + "profile": { + "$ref": "#/definitions/Profile", + "description": "The object containing the job profile information." + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The object containing the job status information." + }, + "user": { + "type": "string", + "description": "The user name of the job creator." + }, + "userargs": { + "$ref": "#/definitions/Userargs", + "description": "The arguments passed in by the user." + } + } + }, + "JobID": { + "description": "The object with the Job ID.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The job number." + }, + "jtIdentifier": { + "type": "string", + "description": "The jobTracker identifier." + } + } + }, + "JobListJsonObject": { + "description": "The List Job operation response.", + "properties": { + "detail": { + "$ref": "#/definitions/JobDetailRootJsonObject", + "description": "The detail of the job." + }, + "id": { + "type": "string", + "description": "The Id of the job." + } + } + }, + "JobSubmissionJsonResponse": { + "description": "The job submission json response.", + "properties": { + "id": { + "type": "string", + "description": "The Id of the created job." + } + } + }, + "Profile": { + "description": "The object containing the job profile information.", + "properties": { + "jobFile": { + "type": "string", + "description": "The job configuration file." + }, + "jobId": { + "type": "string", + "description": "The full ID of the job." + }, + "jobID": { + "$ref": "#/definitions/JobID", + "description": "The ID of the job." + }, + "jobName": { + "type": "string", + "description": "The user-specified job name." + }, + "queueName": { + "type": "string", + "description": "The name of the queue to which the job is submitted." + }, + "url": { + "type": "string", + "description": "The link to the web-ui for details of the job." + }, + "user": { + "type": "string", + "description": "The userid of the person who submitted the job." + } + } + }, + "Status": { + "description": "Gets or sets the object containing the job status information.", + "properties": { + "cleanupProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the cleanup." + }, + "failureInfo": { + "type": "string", + "description": "The information about any failures that have occurred." + }, + "finishTime": { + "type": "integer", + "format": "int64", + "description": "The time at which the job completed. It is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00." + }, + "historyFile": { + "type": "string", + "description": "The history file of the job." + }, + "jobACLs": { + "$ref": "#/definitions/JobACLs", + "description": "The ACLs of the job." + }, + "jobComplete": { + "type": "boolean", + "description": "Whether or not the job has completed." + }, + "jobFile": { + "type": "string", + "description": "The job configuration file." + }, + "jobId": { + "type": "string", + "description": "The full ID of the job." + }, + "jobID": { + "$ref": "#/definitions/JobID", + "description": "The ID of the job." + }, + "jobName": { + "type": "string", + "description": "The user-specified job name." + }, + "jobPriority": { + "type": "string", + "description": "The priority of the job." + }, + "mapProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the maps." + }, + "neededMem": { + "type": "integer", + "format": "int64", + "description": "The amount of memory needed for the job." + }, + "numReservedSlots": { + "type": "integer", + "format": "int32", + "description": "The number of slots reserved." + }, + "numUsedSlots": { + "type": "integer", + "format": "int32", + "description": "The number of slots used for the job." + }, + "priority": { + "type": "string", + "description": "The priority of the job." + }, + "queue": { + "type": "string", + "description": "The job queue name." + }, + "reduceProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the reduces." + }, + "reservedMem": { + "type": "integer", + "format": "int64", + "description": "The amount of memory reserved for the job." + }, + "retired": { + "type": "boolean", + "description": "Whether or not the job has been retired. " + }, + "runState": { + "type": "integer", + "format": "int32", + "description": "The current state of the job." + }, + "schedulingInfo": { + "type": "string", + "description": "The information about the scheduling of the job." + }, + "setupProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the setup." + }, + "startTime": { + "type": "integer", + "format": "int64", + "description": "The time at which the job started. It is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00." + }, + "state": { + "type": "string", + "description": "The state of the job." + }, + "trackingUrl": { + "type": "string", + "description": "The link to the web-ui for details of the job." + }, + "uber": { + "type": "boolean", + "description": "Whether job running in uber mode." + }, + "usedMem": { + "type": "integer", + "format": "int64", + "description": "The amount of memory used by the job." + }, + "username": { + "type": "string", + "description": "The userid of the person who submitted the job." + } + } + }, + "Userargs": { + "description": "Gets or sets the object containing the user arguments.", + "properties": { + "arg": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The list of args defined by the user." + }, + "callback": { + "type": "object", + "description": "The callback URL, if any." + }, + "define": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The define properties defined by the user." + }, + "enablelog": { + "type": "string", + "description": "Whether or not the user enabled logs." + }, + "execute": { + "type": "string", + "description": "The query defined by the user." + }, + "file": { + "type": "object", + "description": "The query file provided by the user." + }, + "files": { + "type": "object", + "description": "The files defined by the user." + }, + "jar": { + "type": "string", + "description": "The JAR file provided by the user." + }, + "statusdir": { + "type": "object", + "description": "The status directory defined by the user." + } + } + } + }, + "parameters": { + "clusterDnsNameParameter": { + "name": "clusterDnsName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The cluster dns name against which the job management is to be.", + "x-ms-parameter-location": "client" + }, + "UserNameParameter": { + "name": "user.name", + "in": "query", + "required": true, + "type": "string", + "description": "The user name used for running job.", + "x-ms-parameter-location": "client" + } + } } \ No newline at end of file diff --git a/specification/hdinsight/data-plane/readme.md b/specification/hdinsight/data-plane/readme.md index 971c20185c64..af69cfc0f9f5 100644 --- a/specification/hdinsight/data-plane/readme.md +++ b/specification/hdinsight/data-plane/readme.md @@ -1,134 +1,134 @@ -# HDInsight - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for HDInsight. - - - ---- -## Getting Started -To build the SDK for HDInsight, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the HDInsight API. - -``` yaml -openapi-type: data-plane -tag: package-2018-11-preview -``` - -### Tag: package-2018-11-preview - -These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-11-preview' -input-file: -- Microsoft.HDInsight/preview/2018-11-01-preview/job.json -``` - - ---- -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-java - - repo: azure-sdk-for-python - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-go -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.HDInsight.Job - output-folder: $(csharp-sdks-folder)/HDInsight/DataPlane/Microsoft.Azure.HDInsight.Job/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -These settings apply only when `--python` is specified on the command line. - -```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - package-name: azure-hdinsight-job - clear-output-folder: true - no-namespace-folders: true -``` - -### Tag: package-2018-11-preview and python - -These settings apply only when `--tag=package-2018-11-preview --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-11-preview' && $(python) -python: - namespace: azure.hdinsight.job - output-folder: $(python-sdks-folder)/azure-hdinsight-job/azure/hdinsight/job -``` - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - namespace: com.microsoft.azure.hdinsight.job - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-hdinsight-job -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-11-preview -``` - -### Tag:package-2018-11-preview and java - -These settings apply only when `--tag=package-2018-11-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-11-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.hdinsight.job.v2018_11_01_preview - output-folder: $(azure-libraries-for-java-folder)/hdinsight/data-plane/v2018_11_01_preview -regenerate-manager: true -generate-interface: true -``` +# HDInsight + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for HDInsight. + + + +--- +## Getting Started +To build the SDK for HDInsight, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the HDInsight API. + +``` yaml +openapi-type: data-plane +tag: package-2018-11-preview +``` + +### Tag: package-2018-11-preview + +These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11-preview' +input-file: +- Microsoft.HDInsight/preview/2018-11-01-preview/job.json +``` + + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-java + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-go +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.HDInsight.Job + output-folder: $(csharp-sdks-folder)/HDInsight/DataPlane/Microsoft.Azure.HDInsight.Job/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +These settings apply only when `--python` is specified on the command line. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-hdinsight-job + clear-output-folder: true + no-namespace-folders: true +``` + +### Tag: package-2018-11-preview and python + +These settings apply only when `--tag=package-2018-11-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(python) +python: + namespace: azure.hdinsight.job + output-folder: $(python-sdks-folder)/azure-hdinsight-job/azure/hdinsight/job +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.hdinsight.job + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-hdinsight-job +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-11-preview +``` + +### Tag:package-2018-11-preview and java + +These settings apply only when `--tag=package-2018-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.hdinsight.job.v2018_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/hdinsight/data-plane/v2018_11_01_preview +regenerate-manager: true +generate-interface: true +``` 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 eabeaa6e40f2..4f209f70406c 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,427 +1,427 @@ -{ - "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." - } - } - }, - "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." - } - } - }, - "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." + } + } + }, + "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." + } + } + }, + "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 c8f0601da9ff..143b131e9695 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,1483 +1,1483 @@ -{ - "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" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey": { - "post": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_RotateDiskEncryptionKey", - "x-ms-examples": { - "Rotate disk encryption key of the specified HDInsight cluster": { - "$ref": "./examples/RotateLinuxHadoopClusterDiskEncryptionKey.json" - } - }, - "description": "Rotate disk encryption key of the specified HDInsight cluster.", - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterDiskEncryptionParameters" - }, - "description": "The parameters for the disk encryption 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/getGatewaySettings": { - "post": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_GetGatewaySettings", - "description": "Gets the gateway settings for the specified cluster.", - "x-ms-examples": { - "Get HTTP settings": { - "$ref": "./examples/HDI_Clusters_GetGatewaySettings.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/GatewaySettings" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateGatewaySettings": { - "post": { - "tags": [ - "Clusters" - ], - "operationId": "Clusters_UpdateGatewaySettings", - "description": "Configures the gateway settings on the specified cluster.", - "x-ms-examples": { - "Enable HTTP connectivity": { - "$ref": "./examples/HDI_Clusters_UpdateGatewaySettings_Enable.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ClusterNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateGatewaySettingsParameters" - }, - "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" - } - }, - "x-ms-long-running-operation": true - } - } - }, - "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" - }, - "aaddsResourceId": { - "type": "string", - "description": "The resource ID of the user's Azure Active Directory Domain Service." - }, - "msiResourceId": { - "type": "string", - "description": "User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS." - } - } - }, - "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." - }, - "resourceId": { - "type": "string", - "description": "The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2." - }, - "msiResourceId": { - "type": "string", - "description": "The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2." - } - }, - "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." - }, - "diskEncryptionProperties": { - "$ref": "#/definitions/DiskEncryptionProperties", - "description": "The disk encryption properties." - } - } - }, - "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." - }, - "identity": { - "$ref": "#/definitions/ClusterIdentity", - "description": "The identity of the cluster, if configured." - } - }, - "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." - }, - "diskEncryptionProperties": { - "$ref": "#/definitions/DiskEncryptionProperties", - "description": "The disk encryption properties." - } - }, - "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." - }, - "identity": { - "$ref": "#/definitions/ClusterIdentity", - "description": "The identity of the cluster, if configured." - } - }, - "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." - }, - "ClusterIdentity": { - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal id of cluster identity. This property will only be provided for a system assigned identity." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "The tenant id associated with the cluster. This property will only be provided for a system assigned identity." - }, - "type": { - "type": "string", - "description": "The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities.", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "ResourceIdentityType", - "modelAsString": false - } - }, - "userAssignedIdentities": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal id of user assigned identity." - }, - "clientId": { - "readOnly": true, - "type": "string", - "description": "The client id of user assigned identity." - } - } - }, - "description": "The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." - } - }, - "description": "Identity for the cluster." - }, - "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." - }, - "ClusterDiskEncryptionParameters": { - "properties": { - "vaultUri": { - "type": "string", - "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" - }, - "keyName": { - "type": "string", - "description": "Key name that is used for enabling disk encryption." - }, - "keyVersion": { - "type": "string", - "description": "Specific key version that is used for enabling disk encryption." - } - }, - "description": "The Disk Encryption Cluster request parameters." - }, - "DiskEncryptionProperties": { - "description": "The disk encryption properties", - "properties": { - "vaultUri": { - "type": "string", - "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" - }, - "keyName": { - "type": "string", - "description": "Key name that is used for enabling disk encryption." - }, - "keyVersion": { - "type": "string", - "description": "Specific key version that is used for enabling disk encryption." - }, - "encryptionAlgorithm": { - "type": "string", - "description": "Algorithm identifier for encryption, default RSA-OAEP.", - "enum": [ - "RSA-OAEP", - "RSA-OAEP-256", - "RSA1_5" - ], - "x-ms-enum": { - "name": "JsonWebKeyEncryptionAlgorithm", - "modelAsString": true - } - }, - "msiResourceId": { - "type": "string", - "description": "Resource ID of Managed Identity that is used to access the key vault." - } - } - }, - "UpdateGatewaySettingsParameters": { - "properties": { - "restAuthCredential.isEnabled": { - "type": "boolean", - "default": true, - "x-ms-client-name": "isCredentialEnabled", - "description": "Indicates whether or not the gateway settings based authorization is enabled." - }, - "restAuthCredential.username": { - "type": "string", - "x-ms-client-name": "userName", - "description": "The gateway settings user name." - }, - "restAuthCredential.password": { - "type": "string", - "x-ms-client-name": "password", - "description": "The gateway settings user password." - } - }, - "description": "The update gateway settings request parameters." - }, - "GatewaySettings": { - "properties": { - "restAuthCredential.isEnabled": { - "type": "string", - "x-ms-client-name": "isCredentialEnabled", - "description": "Indicates whether or not the gateway settings based authorization is enabled.", - "readOnly": true - }, - "restAuthCredential.username": { - "type": "string", - "x-ms-client-name": "userName", - "description": "The gateway settings user name.", - "readOnly": true - }, - "restAuthCredential.password": { - "type": "string", - "x-ms-client-name": "password", - "description": "The gateway settings user password.", - "readOnly": true - } - }, - "description": "Gateway settings." - }, - "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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_RotateDiskEncryptionKey", + "x-ms-examples": { + "Rotate disk encryption key of the specified HDInsight cluster": { + "$ref": "./examples/RotateLinuxHadoopClusterDiskEncryptionKey.json" + } + }, + "description": "Rotate disk encryption key of the specified HDInsight cluster.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterDiskEncryptionParameters" + }, + "description": "The parameters for the disk encryption 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}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/getGatewaySettings": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_GetGatewaySettings", + "description": "Gets the gateway settings for the specified cluster.", + "x-ms-examples": { + "Get HTTP settings": { + "$ref": "./examples/HDI_Clusters_GetGatewaySettings.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/GatewaySettings" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateGatewaySettings": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_UpdateGatewaySettings", + "description": "Configures the gateway settings on the specified cluster.", + "x-ms-examples": { + "Enable HTTP connectivity": { + "$ref": "./examples/HDI_Clusters_UpdateGatewaySettings_Enable.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateGatewaySettingsParameters" + }, + "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" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "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" + }, + "aaddsResourceId": { + "type": "string", + "description": "The resource ID of the user's Azure Active Directory Domain Service." + }, + "msiResourceId": { + "type": "string", + "description": "User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS." + } + } + }, + "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." + }, + "resourceId": { + "type": "string", + "description": "The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2." + }, + "msiResourceId": { + "type": "string", + "description": "The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2." + } + }, + "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." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." + } + } + }, + "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." + }, + "identity": { + "$ref": "#/definitions/ClusterIdentity", + "description": "The identity of the cluster, if configured." + } + }, + "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." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." + } + }, + "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." + }, + "identity": { + "$ref": "#/definitions/ClusterIdentity", + "description": "The identity of the cluster, if configured." + } + }, + "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." + }, + "ClusterIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of cluster identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the cluster. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the cluster." + }, + "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." + }, + "ClusterDiskEncryptionParameters": { + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + } + }, + "description": "The Disk Encryption Cluster request parameters." + }, + "DiskEncryptionProperties": { + "description": "The disk encryption properties", + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + }, + "encryptionAlgorithm": { + "type": "string", + "description": "Algorithm identifier for encryption, default RSA-OAEP.", + "enum": [ + "RSA-OAEP", + "RSA-OAEP-256", + "RSA1_5" + ], + "x-ms-enum": { + "name": "JsonWebKeyEncryptionAlgorithm", + "modelAsString": true + } + }, + "msiResourceId": { + "type": "string", + "description": "Resource ID of Managed Identity that is used to access the key vault." + } + } + }, + "UpdateGatewaySettingsParameters": { + "properties": { + "restAuthCredential.isEnabled": { + "type": "boolean", + "default": true, + "x-ms-client-name": "isCredentialEnabled", + "description": "Indicates whether or not the gateway settings based authorization is enabled." + }, + "restAuthCredential.username": { + "type": "string", + "x-ms-client-name": "userName", + "description": "The gateway settings user name." + }, + "restAuthCredential.password": { + "type": "string", + "x-ms-client-name": "password", + "description": "The gateway settings user password." + } + }, + "description": "The update gateway settings request parameters." + }, + "GatewaySettings": { + "properties": { + "restAuthCredential.isEnabled": { + "type": "string", + "x-ms-client-name": "isCredentialEnabled", + "description": "Indicates whether or not the gateway settings based authorization is enabled.", + "readOnly": true + }, + "restAuthCredential.username": { + "type": "string", + "x-ms-client-name": "userName", + "description": "The gateway settings user name.", + "readOnly": true + }, + "restAuthCredential.password": { + "type": "string", + "x-ms-client-name": "password", + "description": "The gateway settings user password.", + "readOnly": true + } + }, + "description": "Gateway settings." + }, + "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 a6d0c75155f4..4f3d93d13674 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,244 +1,244 @@ -{ - "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": { - "post": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_List", - "description": "Gets all configuration information for an HDI cluster.", - "x-ms-examples": { - "Get all configuration information": { - "$ref": "./examples/HDI_Configurations_List.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/ClusterConfigurations" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { - "post": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_Update", - "description": "Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.", - "deprecated": true, - "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. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.", - "x-ms-examples": { - "Get Core site settings": { - "$ref": "./examples/HDI_Configurations_Get.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." - }, - "ClusterConfigurations": { - "properties": { - "configurations": { - "description": "The configuration object for the specified configuration for the specified cluster.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ClusterConfiguration" - } - } - }, - "description": "The configuration object 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": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_List", + "description": "Gets all configuration information for an HDI cluster.", + "x-ms-examples": { + "Get all configuration information": { + "$ref": "./examples/HDI_Configurations_List.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/ClusterConfigurations" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "description": "Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.", + "deprecated": true, + "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. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.", + "x-ms-examples": { + "Get Core site settings": { + "$ref": "./examples/HDI_Configurations_Get.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." + }, + "ClusterConfigurations": { + "properties": { + "configurations": { + "description": "The configuration object for the specified configuration for the specified cluster.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ClusterConfiguration" + } + } + }, + "description": "The configuration object 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/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/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/HDI_Clusters_GetGatewaySettings.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Clusters_GetGatewaySettings.json index 7b95f0e600e3..5903f3e5a975 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Clusters_GetGatewaySettings.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Clusters_GetGatewaySettings.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "hadoop", - "restAuthCredential.password": "**********" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "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/HDI_Clusters_UpdateGatewaySettings_Enable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json index c16007d978b1..baf7ae208a1e 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json @@ -1,20 +1,20 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "parameters": { - "restAuthCredential.isEnabled": true, - "restAuthCredential.username": "hadoop", - "restAuthCredential.password": "**********" - } - }, - "responses": { - "202": { - "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": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + }, + "responses": { + "202": { + "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/HDI_Configurations_Get.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Configurations_Get.json index e73de18e0339..6ef32e881860 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Configurations_Get.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Configurations_Get.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "configurationName": "core-site" - }, - "responses": { - "200": { - "body": { - "fs.defaultFS":"wasb://test.blob.core.windows.net", - "fs.azure.account.key.test.blob.core.windows.net":"accountKey" - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "configurationName": "core-site" + }, + "responses": { + "200": { + "body": { + "fs.defaultFS":"wasb://test.blob.core.windows.net", + "fs.azure.account.key.test.blob.core.windows.net":"accountKey" + } + } + } } \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Configurations_List.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Configurations_List.json index c653de57ed85..aa1c90a566dd 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Configurations_List.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/HDI_Configurations_List.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "configurations": { - "core-site": { - "fs.defaultFS": "wasb://test.blob.core.windows.net", - "fs.azure.account.key.test.blob.core.windows.net": "accountKey" - }, - "gateway": { - "restAuthCredential.isEnabled": "true", - "restAuthCredential.username": "admin", - "restAuthCredential.password": "**********" - } - } - } - } - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "configurations": { + "core-site": { + "fs.defaultFS": "wasb://test.blob.core.windows.net", + "fs.azure.account.key.test.blob.core.windows.net": "accountKey" + }, + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + } + } + } } \ 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/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/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json index ec02df616300..709efb96e7bb 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json @@ -1,17 +1,17 @@ -{ - "parameters": { - "clusterName": "cluster1", - "resourceGroupName": "rg1", - "api-version": "2015-03-01-preview", - "subscriptionId": "subid", - "parameters": { - "vaultUri": "https://newkeyvault.vault.azure.net/", - "keyName": "newkeyname", - "keyVersion": "newkeyversion" - } - }, - "responses": { - "200": {}, - "202": {} - } +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "vaultUri": "https://newkeyvault.vault.azure.net/", + "keyName": "newkeyname", + "keyVersion": "newkeyversion" + } + }, + "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 9fdd59dab21d..8f51dc9a7eb9 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 compatibility 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 compatibility filters.", - "type": "array", - "items": { - "$ref": "#/definitions/VmSizeCompatibilityFilter" - } - }, - "features": { - "description": "The capability 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 compatibility 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 compatibility filters.", + "type": "array", + "items": { + "$ref": "#/definitions/VmSizeCompatibilityFilter" + } + }, + "features": { + "description": "The capability 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/readme.md b/specification/hdinsight/resource-manager/readme.md index 62cd4dc2f135..f5f95e149eb9 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -1,186 +1,186 @@ -# HDInsight - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for HDInsight. - - - ---- -## Getting Started -To build the SDK for HDInsight, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the HDInsight API. - -``` yaml -title: HDInsightManagementClient -description: HDInsight Management Client -openapi-type: arm -azure-arm: true -tag: package-2018-06-preview -``` - -## Suppression - ``` yaml - directive: - - suppress: DefinitionsPropertiesNamesCamelCase - reason: This would require a breaking change, and the capabilities API was removed in version 2018-06-01-preview. - from: Microsoft.HDInsight/preview/2015-03-01-1/preview/locations.json - where: - - $.definitions.CapabilitiesResult.properties.vmSize_filters - - $.definitions.RegionalQuotaCapability.properties.cores_available - - $.definitions.RegionalQuotaCapability.properties.cores_used - - $.definitions.RegionalQuotaCapability.properties.region_name - - $.definitions.VmSizeCompatibilityFilter.properties.ClusterVersions - - $.definitions.VmSizeCompatibilityFilter.properties.NodeTypes - - $.definitions.VmSizeCompatibilityFilter.properties.ClusterFlavors - - $.definitions.VmSizeCompatibilityFilter.properties.Regions - - $.definitions.VmSizeCompatibilityFilter.properties.FilterMode - ``` - - ``` yaml -directive: - - suppress: R3016 # to suppress (DefinitionsPropertiesNamesCamelCase) - from: cluster.json - reason: The casing of this property is not incorrect. - where: - - $..["restAuthCredential.isEnabled"] - - $..["restAuthCredential.username"] - - $..["restAuthCredential.password"] -``` - -### Tag: package-2018-06-preview - -These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-06-preview' -input-file: -- Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json -- Microsoft.HDInsight/stable/2018-06-01-preview/applications.json -- Microsoft.HDInsight/stable/2018-06-01-preview/locations.json -- Microsoft.HDInsight/stable/2018-06-01-preview/configurations.json -- Microsoft.HDInsight/stable/2018-06-01-preview/extensions.json -- Microsoft.HDInsight/stable/2018-06-01-preview/scriptActions.json -- Microsoft.HDInsight/stable/2018-06-01-preview/operations.json -``` - - -### Tag: package-2015-03-preview - -These settings apply only when `--tag=package-2015-03-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-03-preview' -input-file: -- Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json -- Microsoft.HDInsight/preview/2015-03-01-preview/applications.json -- Microsoft.HDInsight/preview/2015-03-01-preview/locations.json -- Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json -- Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json -- Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json -- Microsoft.HDInsight/preview/2015-03-01-preview/operations.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-java - - repo: azure-sdk-for-python - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.HDInsight - output-folder: $(csharp-sdks-folder)/HDInsight/Management/Management.HDInsight/Generated - clear-output-folder: true -``` - - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.hdinsight -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-hdinsight -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-06-preview - - tag: package-2015-03-preview -``` - - -### Tag: package-2018-06-preview and java - -These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-06-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.hdinsight.v2018_06_01_preview - output-folder: $(azure-libraries-for-java-folder)/hdinsight/resource-manager/v2018_06_01_preview -regenerate-manager: true -generate-interface: true -``` - - -### Tag: package-2015-03-preview and java - -These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-03-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.hdinsight.v2015_03_01_preview - output-folder: $(azure-libraries-for-java-folder)/hdinsight/resource-manager/v2015_03_01_preview -regenerate-manager: true -generate-interface: true -``` - - +# HDInsight + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for HDInsight. + + + +--- +## Getting Started +To build the SDK for HDInsight, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the HDInsight API. + +``` yaml +title: HDInsightManagementClient +description: HDInsight Management Client +openapi-type: arm +azure-arm: true +tag: package-2018-06-preview +``` + +## Suppression + ``` yaml + directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: This would require a breaking change, and the capabilities API was removed in version 2018-06-01-preview. + from: Microsoft.HDInsight/preview/2015-03-01-1/preview/locations.json + where: + - $.definitions.CapabilitiesResult.properties.vmSize_filters + - $.definitions.RegionalQuotaCapability.properties.cores_available + - $.definitions.RegionalQuotaCapability.properties.cores_used + - $.definitions.RegionalQuotaCapability.properties.region_name + - $.definitions.VmSizeCompatibilityFilter.properties.ClusterVersions + - $.definitions.VmSizeCompatibilityFilter.properties.NodeTypes + - $.definitions.VmSizeCompatibilityFilter.properties.ClusterFlavors + - $.definitions.VmSizeCompatibilityFilter.properties.Regions + - $.definitions.VmSizeCompatibilityFilter.properties.FilterMode + ``` + + ``` yaml +directive: + - suppress: R3016 # to suppress (DefinitionsPropertiesNamesCamelCase) + from: cluster.json + reason: The casing of this property is not incorrect. + where: + - $..["restAuthCredential.isEnabled"] + - $..["restAuthCredential.username"] + - $..["restAuthCredential.password"] +``` + +### Tag: package-2018-06-preview + +These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' +input-file: +- Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json +- Microsoft.HDInsight/stable/2018-06-01-preview/applications.json +- Microsoft.HDInsight/stable/2018-06-01-preview/locations.json +- Microsoft.HDInsight/stable/2018-06-01-preview/configurations.json +- Microsoft.HDInsight/stable/2018-06-01-preview/extensions.json +- Microsoft.HDInsight/stable/2018-06-01-preview/scriptActions.json +- Microsoft.HDInsight/stable/2018-06-01-preview/operations.json +``` + + +### Tag: package-2015-03-preview + +These settings apply only when `--tag=package-2015-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-03-preview' +input-file: +- Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json +- Microsoft.HDInsight/preview/2015-03-01-preview/applications.json +- Microsoft.HDInsight/preview/2015-03-01-preview/locations.json +- Microsoft.HDInsight/preview/2015-03-01-preview/configurations.json +- Microsoft.HDInsight/preview/2015-03-01-preview/extensions.json +- Microsoft.HDInsight/preview/2015-03-01-preview/scriptActions.json +- Microsoft.HDInsight/preview/2015-03-01-preview/operations.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-java + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.HDInsight + output-folder: $(csharp-sdks-folder)/HDInsight/Management/Management.HDInsight/Generated + clear-output-folder: true +``` + + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.hdinsight +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-hdinsight +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-06-preview + - tag: package-2015-03-preview +``` + + +### Tag: package-2018-06-preview and java + +These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.hdinsight.v2018_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/hdinsight/resource-manager/v2018_06_01_preview +regenerate-manager: true +generate-interface: true +``` + + +### Tag: package-2015-03-preview and java + +These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.hdinsight.v2015_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/hdinsight/resource-manager/v2015_03_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/intune/resource-manager/readme.md b/specification/intune/resource-manager/readme.md index bdb1e8dbbf57..3d972ff77a83 100644 --- a/specification/intune/resource-manager/readme.md +++ b/specification/intune/resource-manager/readme.md @@ -1,80 +1,80 @@ -# Intune - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Intune. - - - ---- -## Getting Started -To build the SDK for Intune, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Intune API. - -``` yaml -openapi-type: arm -tag: package-2015-01-preview -``` - - -### Tag: package-2015-01-preview - -These settings apply only when `--tag=package-2015-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-01-preview' -input-file: -- Microsoft.Intune/preview/2015-01-14-preview/intune.json -``` - -### Tag: package-2015-01-privatepreview - -These settings apply only when `--tag=package-2015-01-privatepreview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-01-privatepreview' -input-file: -- Microsoft.Intune/preview/2015-01-14-privatepreview/intune.json -``` - ---- -# Code Generation - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Intune - output-folder: $(csharp-sdks-folder)/Intune/Intune/Generated - clear-output-folder: true -``` - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.intune -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-intune -``` +# Intune + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Intune. + + + +--- +## Getting Started +To build the SDK for Intune, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Intune API. + +``` yaml +openapi-type: arm +tag: package-2015-01-preview +``` + + +### Tag: package-2015-01-preview + +These settings apply only when `--tag=package-2015-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-01-preview' +input-file: +- Microsoft.Intune/preview/2015-01-14-preview/intune.json +``` + +### Tag: package-2015-01-privatepreview + +These settings apply only when `--tag=package-2015-01-privatepreview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-01-privatepreview' +input-file: +- Microsoft.Intune/preview/2015-01-14-privatepreview/intune.json +``` + +--- +# Code Generation + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Intune + output-folder: $(csharp-sdks-folder)/Intune/Intune/Generated + clear-output-folder: true +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.intune +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-intune +``` diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index 776af7f089de..9aece9c21c5c 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -1,180 +1,180 @@ -# IotHub - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for IotHub. - ---- - -## Getting Started - -To build the SDK for IotHub, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the IotHub API. - -``` yaml -openapi-type: arm -tag: package-preview-2019-03 -``` - - -### Tag: package-preview-2019-03 - -These settings apply only when `--tag=package-preview-2019-03` is specified on the command line. - -```yaml $(tag) == 'package-preview-2019-03' -input-file: - - Microsoft.Devices/preview/2019-03-22-preview/iothub.json -``` -### Tag: package-2018-12-preview - -These settings apply only when `--tag=package-2018-12-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-12-preview' -input-file: -- Microsoft.Devices/preview/2018-12-01-preview/iothub.json -``` - -### Tag: package-2018-04 - -These settings apply only when `--tag=package-2018-04` is specified on the command line. - -``` yaml $(tag) == 'package-2018-04' -input-file: -- Microsoft.Devices/stable/2018-04-01/iothub.json -``` - -### Tag: package-2018-01 - -These settings apply only when `--tag=package-2018-01` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01' -input-file: -- Microsoft.Devices/stable/2018-01-22/iothub.json -``` - -### Tag: package-2017-07 - -These settings apply only when `--tag=package-2017-07` is specified on the command line. - -``` yaml $(tag) == 'package-2017-07' -input-file: -- Microsoft.Devices/stable/2017-07-01/iothub.json -``` - -### Tag: package-2017-01 - -These settings apply only when `--tag=package-2017-01` is specified on the command line. - -``` yaml $(tag) == 'package-2017-01' -input-file: -- Microsoft.Devices/stable/2017-01-19/iothub.json -``` - -### Tag: package-2016-02 - -These settings apply only when `--tag=package-2016-02` is specified on the command line. - -``` yaml $(tag) == 'package-2016-02' -input-file: -- Microsoft.Devices/stable/2016-02-03/iothub.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_iot_hub'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.IotHub - output-folder: $(csharp-sdks-folder)/IotHub/Management.IotHub/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.iothub -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-iothub -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-12-preview - - tag: package-2018-04 -``` - -### Tag: package-2018-12-preview and java - -These settings apply only when `--tag=package-2018-12-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-12-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.iothub.v2018_12_01_preview - output-folder: $(azure-libraries-for-java-folder)/iothub/resource-manager/v2018_12_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-04 and java - -These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.iothub.v2018_04_01 - output-folder: $(azure-libraries-for-java-folder)/iothub/resource-manager/v2018_04_01 -regenerate-manager: true -generate-interface: true -``` +# IotHub + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for IotHub. + +--- + +## Getting Started + +To build the SDK for IotHub, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the IotHub API. + +``` yaml +openapi-type: arm +tag: package-preview-2019-03 +``` + + +### Tag: package-preview-2019-03 + +These settings apply only when `--tag=package-preview-2019-03` is specified on the command line. + +```yaml $(tag) == 'package-preview-2019-03' +input-file: + - Microsoft.Devices/preview/2019-03-22-preview/iothub.json +``` +### Tag: package-2018-12-preview + +These settings apply only when `--tag=package-2018-12-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12-preview' +input-file: +- Microsoft.Devices/preview/2018-12-01-preview/iothub.json +``` + +### Tag: package-2018-04 + +These settings apply only when `--tag=package-2018-04` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04' +input-file: +- Microsoft.Devices/stable/2018-04-01/iothub.json +``` + +### Tag: package-2018-01 + +These settings apply only when `--tag=package-2018-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01' +input-file: +- Microsoft.Devices/stable/2018-01-22/iothub.json +``` + +### Tag: package-2017-07 + +These settings apply only when `--tag=package-2017-07` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07' +input-file: +- Microsoft.Devices/stable/2017-07-01/iothub.json +``` + +### Tag: package-2017-01 + +These settings apply only when `--tag=package-2017-01` is specified on the command line. + +``` yaml $(tag) == 'package-2017-01' +input-file: +- Microsoft.Devices/stable/2017-01-19/iothub.json +``` + +### Tag: package-2016-02 + +These settings apply only when `--tag=package-2016-02` is specified on the command line. + +``` yaml $(tag) == 'package-2016-02' +input-file: +- Microsoft.Devices/stable/2016-02-03/iothub.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_iot_hub'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.IotHub + output-folder: $(csharp-sdks-folder)/IotHub/Management.IotHub/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.iothub +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-iothub +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-12-preview + - tag: package-2018-04 +``` + +### Tag: package-2018-12-preview and java + +These settings apply only when `--tag=package-2018-12-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-12-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.iothub.v2018_12_01_preview + output-folder: $(azure-libraries-for-java-folder)/iothub/resource-manager/v2018_12_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-04 and java + +These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.iothub.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/iothub/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/keyvault/data-plane/readme.md b/specification/keyvault/data-plane/readme.md index 5795338b2b97..77560b3500c7 100644 --- a/specification/keyvault/data-plane/readme.md +++ b/specification/keyvault/data-plane/readme.md @@ -1,111 +1,111 @@ -# KeyVault - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for KeyVault. - - - ---- -## Getting Started -To build the SDK for KeyVault, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the KeyVault API. - -``` yaml -openapi-type: data-plane -tag: package-7.0 -``` - -### Tag: package-7.0 - -These settings apply only when `--tag=package-7.0` is specified on the command line. - -``` yaml $(tag) == 'package-7.0' -input-file: -- Microsoft.KeyVault/stable/7.0/keyvault.json -``` - -### Tag: package-2016-10 - -These settings apply only when `--tag=package-2016-10` is specified on the command line. - -``` yaml $(tag) == 'package-2016-10' -input-file: -- Microsoft.KeyVault/stable/2016-10-01/keyvault.json -``` - -### Tag: package-2015-06 - -These settings apply only when `--tag=package-2015-06` is specified on the command line. - -``` yaml $(tag) == 'package-2015-06' -input-file: -- Microsoft.KeyVault/stable/2015-06-01/keyvault.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-python -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.KeyVault - sync-methods: None - output-folder: $(csharp-sdks-folder)/KeyVault/dataPlane/Microsoft.Azure.KeyVault/Generated - clear-output-folder: true -``` - - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - namespace: com.microsoft.azure.keyvault - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 0 - output-folder: $(azure-libraries-for-java-folder)/azure-keyvault - override-client-name: KeyVaultClientBase +# KeyVault + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for KeyVault. + + + +--- +## Getting Started +To build the SDK for KeyVault, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the KeyVault API. + +``` yaml +openapi-type: data-plane +tag: package-7.0 +``` + +### Tag: package-7.0 + +These settings apply only when `--tag=package-7.0` is specified on the command line. + +``` yaml $(tag) == 'package-7.0' +input-file: +- Microsoft.KeyVault/stable/7.0/keyvault.json +``` + +### Tag: package-2016-10 + +These settings apply only when `--tag=package-2016-10` is specified on the command line. + +``` yaml $(tag) == 'package-2016-10' +input-file: +- Microsoft.KeyVault/stable/2016-10-01/keyvault.json +``` + +### Tag: package-2015-06 + +These settings apply only when `--tag=package-2015-06` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06' +input-file: +- Microsoft.KeyVault/stable/2015-06-01/keyvault.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-python +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.KeyVault + sync-methods: None + output-folder: $(csharp-sdks-folder)/KeyVault/dataPlane/Microsoft.Azure.KeyVault/Generated + clear-output-folder: true +``` + + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.keyvault + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 0 + output-folder: $(azure-libraries-for-java-folder)/azure-keyvault + override-client-name: KeyVaultClientBase ``` \ No newline at end of file diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index 20bab62a7b4a..bb1096583de2 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -1,142 +1,142 @@ -# KeyVault - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for KeyVault. - - - ---- -## Getting Started -To build the SDK for KeyVault, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the KeyVault API. - -``` yaml -openapi-type: arm -tag: package-2018-02 -``` - - -### Tag: package-2018-02 - -These settings apply only when `--tag=package-2018-02` is specified on the command line. - -``` yaml $(tag) == 'package-2018-02' -input-file: -- Microsoft.KeyVault/stable/2018-02-14/keyvault.json -- Microsoft.KeyVault/stable/2018-02-14/providers.json -``` - - - -### Tag: package-2016-10 - -These settings apply only when `--tag=package-2016-10` is specified on the command line. - -``` yaml $(tag) == 'package-2016-10' -input-file: -- Microsoft.KeyVault/stable/2016-10-01/keyvault.json -- Microsoft.KeyVault/stable/2016-10-01/providers.json -``` - - -### Tag: package-2015-06 - -These settings apply only when `--tag=package-2015-06` is specified on the command line. - -``` yaml $(tag) == 'package-2015-06' -input-file: -- Microsoft.KeyVault/stable/2015-06-01/keyvault.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-keyvault - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_key_vault'] -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -namespace: com.microsoft.azure.management.keyvault -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-keyvault -``` - -### Java multi-api - -```yaml $(java) && $(multiapi) -batch: - - tag: package-2016-10 - - tag: package-2015-06 -``` - -### Tag: package-2016-10 and java - -These settings apply only when `--tag=package-2016-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.keyvault.v2016_10_01 - output-folder: $(azure-libraries-for-java-folder)/keyvault/resource-manager/v2016_10_01 -regenerate-manager: true -generate-interface: true -directive: - from: keyvault.json - where: $.paths["/subscriptions/{subscriptionId}/resources"].get - transform: $['operationId'] = 'Vaults_ListResource' -``` - -### Tag: package-2015-06 and java - -These settings apply only when `--tag=package-2015-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2015-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.keyvault.v2015_06_01 - output-folder: $(azure-libraries-for-java-folder)/keyvault/resource-manager/v2015_06_01 -regenerate-manager: true -generate-interface: true -``` +# KeyVault + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for KeyVault. + + + +--- +## Getting Started +To build the SDK for KeyVault, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the KeyVault API. + +``` yaml +openapi-type: arm +tag: package-2018-02 +``` + + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.KeyVault/stable/2018-02-14/keyvault.json +- Microsoft.KeyVault/stable/2018-02-14/providers.json +``` + + + +### Tag: package-2016-10 + +These settings apply only when `--tag=package-2016-10` is specified on the command line. + +``` yaml $(tag) == 'package-2016-10' +input-file: +- Microsoft.KeyVault/stable/2016-10-01/keyvault.json +- Microsoft.KeyVault/stable/2016-10-01/providers.json +``` + + +### Tag: package-2015-06 + +These settings apply only when `--tag=package-2015-06` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06' +input-file: +- Microsoft.KeyVault/stable/2015-06-01/keyvault.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-keyvault + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_key_vault'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +namespace: com.microsoft.azure.management.keyvault +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-keyvault +``` + +### Java multi-api + +```yaml $(java) && $(multiapi) +batch: + - tag: package-2016-10 + - tag: package-2015-06 +``` + +### Tag: package-2016-10 and java + +These settings apply only when `--tag=package-2016-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.keyvault.v2016_10_01 + output-folder: $(azure-libraries-for-java-folder)/keyvault/resource-manager/v2016_10_01 +regenerate-manager: true +generate-interface: true +directive: + from: keyvault.json + where: $.paths["/subscriptions/{subscriptionId}/resources"].get + transform: $['operationId'] = 'Vaults_ListResource' +``` + +### Tag: package-2015-06 and java + +These settings apply only when `--tag=package-2015-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2015-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.keyvault.v2015_06_01 + output-folder: $(azure-libraries-for-java-folder)/keyvault/resource-manager/v2015_06_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/labservices/resource-manager/readme.md b/specification/labservices/resource-manager/readme.md index a696f126b072..b098edad5850 100644 --- a/specification/labservices/resource-manager/readme.md +++ b/specification/labservices/resource-manager/readme.md @@ -1,144 +1,144 @@ -# LabServices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for LabServices. - - - ---- -## Getting Started -To build the SDK for LabServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the LabServices API. - -``` yaml -openapi-type: arm -tag: package-2018-10 -``` - - -### Tag: package-2018-10 - -These settings apply only when `--tag=package-2018-10` is specified on the command line. - -``` yaml $(tag) == 'package-2018-10' -input-file: -- Microsoft.LabServices/stable/2018-10-15/ML.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_labservices'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.LabServices - output-folder: $(csharp-sdks-folder)/LabServices/Management.LabServices/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.labservices - package-name: azure-mgmt-labservices - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-labservices/azure/mgmt/labservices -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-labservices -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.labservices -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-labservices -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-10 -``` - -### Tag: package-2018-10 and java - -These settings apply only when `--tag=package-2018-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.labservices.v2018_10_15 - output-folder: $(azure-libraries-for-java-folder)/labservices/resource-manager/v2018_10_15 -regenerate-manager: true -generate-interface: true -``` - - - +# LabServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for LabServices. + + + +--- +## Getting Started +To build the SDK for LabServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the LabServices API. + +``` yaml +openapi-type: arm +tag: package-2018-10 +``` + + +### Tag: package-2018-10 + +These settings apply only when `--tag=package-2018-10` is specified on the command line. + +``` yaml $(tag) == 'package-2018-10' +input-file: +- Microsoft.LabServices/stable/2018-10-15/ML.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_labservices'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.LabServices + output-folder: $(csharp-sdks-folder)/LabServices/Management.LabServices/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.labservices + package-name: azure-mgmt-labservices + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-labservices/azure/mgmt/labservices +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-labservices +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.labservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-labservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-10 +``` + +### Tag: package-2018-10 and java + +These settings apply only when `--tag=package-2018-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.labservices.v2018_10_15 + output-folder: $(azure-libraries-for-java-folder)/labservices/resource-manager/v2018_10_15 +regenerate-manager: true +generate-interface: true +``` + + + diff --git a/specification/logic/resource-manager/readme.md b/specification/logic/resource-manager/readme.md index 0a974ecfebaa..050cbc128f73 100644 --- a/specification/logic/resource-manager/readme.md +++ b/specification/logic/resource-manager/readme.md @@ -1,222 +1,222 @@ -# Logic - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Logic. - ---- - -## Getting Started - -To build the SDK for Logic, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - -### Basic Information - -These are the global settings for the Logic API. - -``` yaml -openapi-type: arm -tag: package-2018-07-preview - -directive: - - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces"].post.responses["200"].schema - suppress: - - CollectionObjectPropertiesNaming - - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces"].post.responses["200"].schema - suppress: - - CollectionObjectPropertiesNaming - -``` - -### Tag: package-2018-07-preview - -These settings apply only when `--package-2018-07-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-07-preview' -input-file: -- Microsoft.Logic/preview/2018-07-01-preview/logic.json -``` - -## Suppression - -``` yaml -directive: - - suppress: R3016 - reason: Existing properties, can't be changed without breaking API. - #where: - # - $.definitions.AS2ErrorSettings.properties.resendIfMDNNotReceived - # - $.definitions.AS2MdnSettings.properties.needMDN - # - $.definitions.AS2MdnSettings.properties.signMDN - # - $.definitions.AS2MdnSettings.properties.sendMDNAsynchronously - # - $.definitions.AS2MdnSettings.properties.signOutboundMDNIfOptional - # - $.definitions.AS2MdnSettings.properties.sendInboundMDNToMessageBox - # - $.definitions.AS2SecuritySettings.properties.enableNRRForInboundEncodedMessages - # - $.definitions.AS2SecuritySettings.properties.enableNRRForInboundDecodedMessages - # - $.definitions.AS2SecuritySettings.properties.enableNRRForOutboundMDN - # - $.definitions.AS2SecuritySettings.properties.enableNRRForOutboundEncodedMessages - # - $.definitions.AS2SecuritySettings.properties.enableNRRForOutboundDecodedMessages - # - $.definitions.AS2SecuritySettings.properties.enableNRRForInboundMDN - # - $.definitions.EdifactValidationSettings.properties.validateEDITypes - # - $.definitions.EdifactValidationSettings.properties.validateXSDTypes - # - $.definitions.EdifactValidationOverride.properties.validateEDITypes - # - $.definitions.EdifactValidationOverride.properties.validateXSDTypes - # - $.definitions.X12ValidationSettings.properties.validateEDITypes - # - $.definitions.X12ValidationSettings.properties.validateXSDTypes - # - $.definitions.X12ValidationOverride.properties.validateEDITypes - # - $.definitions.X12ValidationOverride.properties.validateXSDTypes - -``` - -### Tag: package-2016-06 - -These settings apply only when `--tag=package-2016-06` is specified on the command line. - -``` yaml $(tag) == 'package-2016-06' -input-file: -- Microsoft.Logic/stable/2016-06-01/logic.json -``` - -### Tag: package-2015-08-preview - -These settings apply only when `--tag=package-2015-08-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-08-preview' -input-file: -- Microsoft.Logic/preview/2015-08-01-preview/logic.json -``` - -### Tag: package-2015-02-preview - -These settings apply only when `--tag=package-2015-02-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-02-preview' -input-file: -- Microsoft.Logic/preview/2015-02-01-preview/logic.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_logic'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Logic - output-folder: $(csharp-sdks-folder)/Logic/Management.Logic/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.logic - package-name: azure-mgmt-logic - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-logic/azure/mgmt/logic -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-logic -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.logic -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-logic -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-07-preview - - tag: package-2016-06 -``` - -### Tag: package-2018-07-preview and java - -These settings apply only when `--tag=package-2018-07-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-07-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.logic.v2018_07_01_preview - output-folder: $(azure-libraries-for-java-folder)/logic/resource-manager/v2018_07_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-06 and java - -These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.logic.v2016_06_01 - output-folder: $(azure-libraries-for-java-folder)/logic/resource-manager/v2016_06_01 -regenerate-manager: true -generate-interface: true -``` +# Logic + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Logic. + +--- + +## Getting Started + +To build the SDK for Logic, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information + +These are the global settings for the Logic API. + +``` yaml +openapi-type: arm +tag: package-2018-07-preview + +directive: + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces"].post.responses["200"].schema + suppress: + - CollectionObjectPropertiesNaming + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces"].post.responses["200"].schema + suppress: + - CollectionObjectPropertiesNaming + +``` + +### Tag: package-2018-07-preview + +These settings apply only when `--package-2018-07-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-preview' +input-file: +- Microsoft.Logic/preview/2018-07-01-preview/logic.json +``` + +## Suppression + +``` yaml +directive: + - suppress: R3016 + reason: Existing properties, can't be changed without breaking API. + #where: + # - $.definitions.AS2ErrorSettings.properties.resendIfMDNNotReceived + # - $.definitions.AS2MdnSettings.properties.needMDN + # - $.definitions.AS2MdnSettings.properties.signMDN + # - $.definitions.AS2MdnSettings.properties.sendMDNAsynchronously + # - $.definitions.AS2MdnSettings.properties.signOutboundMDNIfOptional + # - $.definitions.AS2MdnSettings.properties.sendInboundMDNToMessageBox + # - $.definitions.AS2SecuritySettings.properties.enableNRRForInboundEncodedMessages + # - $.definitions.AS2SecuritySettings.properties.enableNRRForInboundDecodedMessages + # - $.definitions.AS2SecuritySettings.properties.enableNRRForOutboundMDN + # - $.definitions.AS2SecuritySettings.properties.enableNRRForOutboundEncodedMessages + # - $.definitions.AS2SecuritySettings.properties.enableNRRForOutboundDecodedMessages + # - $.definitions.AS2SecuritySettings.properties.enableNRRForInboundMDN + # - $.definitions.EdifactValidationSettings.properties.validateEDITypes + # - $.definitions.EdifactValidationSettings.properties.validateXSDTypes + # - $.definitions.EdifactValidationOverride.properties.validateEDITypes + # - $.definitions.EdifactValidationOverride.properties.validateXSDTypes + # - $.definitions.X12ValidationSettings.properties.validateEDITypes + # - $.definitions.X12ValidationSettings.properties.validateXSDTypes + # - $.definitions.X12ValidationOverride.properties.validateEDITypes + # - $.definitions.X12ValidationOverride.properties.validateXSDTypes + +``` + +### Tag: package-2016-06 + +These settings apply only when `--tag=package-2016-06` is specified on the command line. + +``` yaml $(tag) == 'package-2016-06' +input-file: +- Microsoft.Logic/stable/2016-06-01/logic.json +``` + +### Tag: package-2015-08-preview + +These settings apply only when `--tag=package-2015-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08-preview' +input-file: +- Microsoft.Logic/preview/2015-08-01-preview/logic.json +``` + +### Tag: package-2015-02-preview + +These settings apply only when `--tag=package-2015-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-02-preview' +input-file: +- Microsoft.Logic/preview/2015-02-01-preview/logic.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_logic'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Logic + output-folder: $(csharp-sdks-folder)/Logic/Management.Logic/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.logic + package-name: azure-mgmt-logic + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-logic/azure/mgmt/logic +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-logic +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.logic +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-logic +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-07-preview + - tag: package-2016-06 +``` + +### Tag: package-2018-07-preview and java + +These settings apply only when `--tag=package-2018-07-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-07-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.logic.v2018_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/logic/resource-manager/v2018_07_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-06 and java + +These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.logic.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/logic/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/machinelearning/resource-manager/readme.md b/specification/machinelearning/resource-manager/readme.md index 0ae0315ff137..bdbf36231972 100644 --- a/specification/machinelearning/resource-manager/readme.md +++ b/specification/machinelearning/resource-manager/readme.md @@ -1,224 +1,224 @@ -# MachineLearning - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for MachineLearning. - - - ---- -## Getting Started -To build the SDK for MachineLearning, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the MachineLearning API. - -``` yaml -openapi-type: arm -``` - -``` yaml $(package-webservices) -tag: package-webservices-2017-01 -``` - -``` yaml $(package-commitmentPlans) -tag: package-commitmentPlans-2016-05-preview -``` - -``` yaml $(package-workspaces) -tag: package-workspaces-2016-04 -``` - -### Tag: package-webservices-2017-01 - -These settings apply only when `--tag=package-webservices-2017-01` is specified on the command line. - -``` yaml $(tag) == 'package-webservices-2017-01' -input-file: -- Microsoft.MachineLearning/stable/2017-01-01/webservices.json -``` - -### Tag: package-commitmentPlans-2016-05-preview - -These settings apply only when `--tag=package-commitmentPlans-2016-05-preview` is specified on the command line. - -``` yaml $(tag) == 'package-commitmentPlans-2016-05-preview' -input-file: -- Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json -``` - -### Tag: package-workspaces-2016-04 - -These settings apply only when `--tag=package-workspaces-2016-04` is specified on the command line. - -``` yaml $(tag) == 'package-workspaces-2016-04' -input-file: -- Microsoft.MachineLearning/stable/2016-04-01/workspaces.json -``` - -### Tag: package-webservices-2016-05-preview - -These settings apply only when `--tag=package-webservices-2016-05-preview` is specified on the command line. - -``` yaml $(tag) == 'package-webservices-2016-05-preview' -input-file: -- Microsoft.MachineLearning/preview/2016-05-01-preview/webservices.json -``` - - -## Suppression -``` yaml -directive: - - suppress: TrackedResourcePatchOperation - from: commitmentPlans.json - where: $.definitions.CommitmentAssociation - reason: The CommitmentAssociation is an internal association from a Web Service to a Commitment Plan, which can only be created or updated by Web Service Resource Provider. -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_machine_learning'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - azure-arm: true - payload-flattening-threshold: 1 - license-header: MICROSOFT_MIT_NO_VERSION - clear-output-folder: true -batch: - - package-webservices: true - namespace: Microsoft.Azure.Management.MachineLearning.WebServices - output-folder: $(csharp-sdks-folder)/MachineLearning/Management.MachineLearning/Generated/WebServices - - package-commitmentPlans: true - namespace: Microsoft.Azure.Management.MachineLearning.CommitmentPlans - output-folder: $(csharp-sdks-folder)/MachineLearning/Management.MachineLearning/Generated/CommitmentPlans - - package-workspaces: true - namespace: Microsoft.Azure.Management.MachineLearning.Workspaces - output-folder: $(csharp-sdks-folder)/MachineLearning/Management.MachineLearning/Generated/Workspaces -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.machinelearning -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning -``` - -# Validation - -Since this RP has no unique default package, iterate over all of them for validation: - -``` yaml $(validation) -batch: - - package-webservices: true - - package-commitmentPlans: true - - package-workspaces: true -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-webservices-2017-01 - - tag: package-commitmentPlans-2016-05-preview - - tag: package-webservices-2016-05-preview - - tag: package-workspaces-2016-04 -``` - -### Tag: package-webservices-2017-01 and java - -These settings apply only when `--tag=package-webservices-2017-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-webservices-2017-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.machinelearning.v2017_01_01 - output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2017_01_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-commitmentPlans-2016-05-preview and java - -These settings apply only when `--tag=package-commitmentPlans-2016-05-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-commitmentPlans-2016-05-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.machinelearning.v2016_05_01_preview - output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_05_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-webservices-2016-05-preview and java - -These settings apply only when `--tag=package-webservices-2016-05-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-webservices-2016-05-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.machinelearning.v2016_05_01_preview - output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_05_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-workspaces-2016-04 and java - -These settings apply only when `--tag=package-workspaces-2016-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-workspaces-2016-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.machinelearning.v2016_04_01 - output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_04_01 -regenerate-manager: true -generate-interface: true -``` - - +# MachineLearning + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for MachineLearning. + + + +--- +## Getting Started +To build the SDK for MachineLearning, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the MachineLearning API. + +``` yaml +openapi-type: arm +``` + +``` yaml $(package-webservices) +tag: package-webservices-2017-01 +``` + +``` yaml $(package-commitmentPlans) +tag: package-commitmentPlans-2016-05-preview +``` + +``` yaml $(package-workspaces) +tag: package-workspaces-2016-04 +``` + +### Tag: package-webservices-2017-01 + +These settings apply only when `--tag=package-webservices-2017-01` is specified on the command line. + +``` yaml $(tag) == 'package-webservices-2017-01' +input-file: +- Microsoft.MachineLearning/stable/2017-01-01/webservices.json +``` + +### Tag: package-commitmentPlans-2016-05-preview + +These settings apply only when `--tag=package-commitmentPlans-2016-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-commitmentPlans-2016-05-preview' +input-file: +- Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json +``` + +### Tag: package-workspaces-2016-04 + +These settings apply only when `--tag=package-workspaces-2016-04` is specified on the command line. + +``` yaml $(tag) == 'package-workspaces-2016-04' +input-file: +- Microsoft.MachineLearning/stable/2016-04-01/workspaces.json +``` + +### Tag: package-webservices-2016-05-preview + +These settings apply only when `--tag=package-webservices-2016-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-webservices-2016-05-preview' +input-file: +- Microsoft.MachineLearning/preview/2016-05-01-preview/webservices.json +``` + + +## Suppression +``` yaml +directive: + - suppress: TrackedResourcePatchOperation + from: commitmentPlans.json + where: $.definitions.CommitmentAssociation + reason: The CommitmentAssociation is an internal association from a Web Service to a Commitment Plan, which can only be created or updated by Web Service Resource Provider. +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_machine_learning'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + payload-flattening-threshold: 1 + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +batch: + - package-webservices: true + namespace: Microsoft.Azure.Management.MachineLearning.WebServices + output-folder: $(csharp-sdks-folder)/MachineLearning/Management.MachineLearning/Generated/WebServices + - package-commitmentPlans: true + namespace: Microsoft.Azure.Management.MachineLearning.CommitmentPlans + output-folder: $(csharp-sdks-folder)/MachineLearning/Management.MachineLearning/Generated/CommitmentPlans + - package-workspaces: true + namespace: Microsoft.Azure.Management.MachineLearning.Workspaces + output-folder: $(csharp-sdks-folder)/MachineLearning/Management.MachineLearning/Generated/Workspaces +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.machinelearning +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning +``` + +# Validation + +Since this RP has no unique default package, iterate over all of them for validation: + +``` yaml $(validation) +batch: + - package-webservices: true + - package-commitmentPlans: true + - package-workspaces: true +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-webservices-2017-01 + - tag: package-commitmentPlans-2016-05-preview + - tag: package-webservices-2016-05-preview + - tag: package-workspaces-2016-04 +``` + +### Tag: package-webservices-2017-01 and java + +These settings apply only when `--tag=package-webservices-2017-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-webservices-2017-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2017_01_01 + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2017_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-commitmentPlans-2016-05-preview and java + +These settings apply only when `--tag=package-commitmentPlans-2016-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-commitmentPlans-2016-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2016_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_05_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-webservices-2016-05-preview and java + +These settings apply only when `--tag=package-webservices-2016-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-webservices-2016-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2016_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_05_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-workspaces-2016-04 and java + +These settings apply only when `--tag=package-workspaces-2016-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-workspaces-2016-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearning.v2016_04_01 + output-folder: $(azure-libraries-for-java-folder)/machinelearning/resource-manager/v2016_04_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/machinelearningcompute/resource-manager/readme.md b/specification/machinelearningcompute/resource-manager/readme.md index 002485680e84..d1412659f044 100644 --- a/specification/machinelearningcompute/resource-manager/readme.md +++ b/specification/machinelearningcompute/resource-manager/readme.md @@ -1,151 +1,151 @@ -# MachineLearningCompute - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Machine Learning Compute. - - - ---- -## Getting Started -To build the SDK for EventHub, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Machine Learning Compute API. - -``` yaml -openapi-type: arm -tag: package-2017-08-preview -``` - - -### Tag: package-2017-08-preview - -These settings apply only when `--tag=package-2017-08-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-08-preview' -input-file: -- Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json -``` - - -### Tag: package-2017-06-preview - -These settings apply only when `--tag=package-2017-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-06-preview' -input-file: -- Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.MachineLearningCompute - output-folder: $(csharp-sdks-folder)/MachineLearningCompute/Management.MachineLearningCompute/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.machinelearningcompute - package-name: azure-mgmt-machinelearningcompute - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-machinelearningcompute/azure/mgmt/machinelearningcompute -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-machinelearningcompute -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.machinelearning.compute -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/compute -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-08-preview -``` - -### Tag: package-2017-08-preview and java - -These settings apply only when `--tag=package-2017-08-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-08-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.machinelearningcompute.v2017_08_01_preview - output-folder: $(azure-libraries-for-java-folder)/machinelearningcompute/resource-manager/v2017_08_01_preview -regenerate-manager: true -generate-interface: true -``` - - +# MachineLearningCompute + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Machine Learning Compute. + + + +--- +## Getting Started +To build the SDK for EventHub, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Machine Learning Compute API. + +``` yaml +openapi-type: arm +tag: package-2017-08-preview +``` + + +### Tag: package-2017-08-preview + +These settings apply only when `--tag=package-2017-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-08-preview' +input-file: +- Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json +``` + + +### Tag: package-2017-06-preview + +These settings apply only when `--tag=package-2017-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06-preview' +input-file: +- Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.MachineLearningCompute + output-folder: $(csharp-sdks-folder)/MachineLearningCompute/Management.MachineLearningCompute/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.machinelearningcompute + package-name: azure-mgmt-machinelearningcompute + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-machinelearningcompute/azure/mgmt/machinelearningcompute +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-machinelearningcompute +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.machinelearning.compute +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/compute +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-08-preview +``` + +### Tag: package-2017-08-preview and java + +These settings apply only when `--tag=package-2017-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearningcompute.v2017_08_01_preview + output-folder: $(azure-libraries-for-java-folder)/machinelearningcompute/resource-manager/v2017_08_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index c13cf8ad77e3..733b2353a0f1 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -1,231 +1,231 @@ -# MediaServices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for MediaServices. - ---- - -## Getting Started - -To build the SDK for MediaServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the MediaServices API. - -``` yaml -openapi-type: arm -tag: package-2018-07 -opt-in-extensible-enums: true - -``` - - -### Tag: package-2018-07 - -These settings apply only when `--tag=package-2018-07` is specified on the command line. - -```yaml $(tag) == 'package-2018-07' -input-file: - - Microsoft.Media/stable/2018-07-01/AccountFilters.json - - Microsoft.Media/stable/2018-07-01/Accounts.json - - Microsoft.Media/stable/2018-07-01/AssetsAndAssetFilters.json - - Microsoft.Media/stable/2018-07-01/Common.json - - Microsoft.Media/stable/2018-07-01/ContentKeyPolicies.json - - Microsoft.Media/stable/2018-07-01/Encoding.json - - Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json - - Microsoft.Media/stable/2018-07-01/streamingservice.json -``` -### Tag: package-2015-10 - -These settings apply only when `--tag=package-2015-10` is specified on the command line. - -``` yaml $(tag) == 'package-2015-10' -input-file: -- Microsoft.Media/stable/2015-10-01/media.json -``` - -### Tag: package-2018-03-preview - -These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03-preview' -input-file: -- Microsoft.Media/preview/2018-03-30-preview/Accounts.json -- Microsoft.Media/preview/2018-03-30-preview/Assets.json -- Microsoft.Media/preview/2018-03-30-preview/ContentKeyPolicies.json -- Microsoft.Media/preview/2018-03-30-preview/Encoding.json -- Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json -- Microsoft.Media/preview/2018-03-30-preview/streamingservice.json -``` - -### Tag: package-2018-06-preview - -These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-06-preview' -input-file: -- Microsoft.Media/preview/2018-06-01-preview/Accounts.json -- Microsoft.Media/preview/2018-06-01-preview/Assets.json -- Microsoft.Media/preview/2018-06-01-preview/ContentKeyPolicies.json -- Microsoft.Media/preview/2018-06-01-preview/Encoding.json -- Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json -- Microsoft.Media/preview/2018-06-01-preview/streamingservice.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_media_services'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # last generated from commit 3586e2989d502434c4f607dd38d40e46aabede5c - azure-arm: true - payload-flattening-threshold: 2 - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Media - output-folder: $(csharp-sdks-folder)/Media/Management.Media/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.media - package-name: azure-mgmt-media - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-media/azure/mgmt/media -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-media -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.mediaservices -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mediaservices -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-10 - - tag: package-2018-03-preview - - tag: package-2018-06-preview - - tag: package-2018-07 -``` - -### Tag: package-2015-10 and java - -These settings apply only when `--tag=package-2015-10 --java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2015-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.mediaservices.v2015_10_01 - output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2015_10_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-03-preview and java - -These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.mediaservices.v2018_03_30_preview - output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_03_30_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-06-preview and java - -These settings apply only when `--tag=package-2018-06-preview --java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-06-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.mediaservices.v2018_06_01_preview - output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_06_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-07 and java - -These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. -Please also specify the `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.mediaservices.v2018_07_01 - output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_07_01 -regenerate-manager: true -generate-interface: true +# MediaServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for MediaServices. + +--- + +## Getting Started + +To build the SDK for MediaServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the MediaServices API. + +``` yaml +openapi-type: arm +tag: package-2018-07 +opt-in-extensible-enums: true + +``` + + +### Tag: package-2018-07 + +These settings apply only when `--tag=package-2018-07` is specified on the command line. + +```yaml $(tag) == 'package-2018-07' +input-file: + - Microsoft.Media/stable/2018-07-01/AccountFilters.json + - Microsoft.Media/stable/2018-07-01/Accounts.json + - Microsoft.Media/stable/2018-07-01/AssetsAndAssetFilters.json + - Microsoft.Media/stable/2018-07-01/Common.json + - Microsoft.Media/stable/2018-07-01/ContentKeyPolicies.json + - Microsoft.Media/stable/2018-07-01/Encoding.json + - Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json + - Microsoft.Media/stable/2018-07-01/streamingservice.json +``` +### Tag: package-2015-10 + +These settings apply only when `--tag=package-2015-10` is specified on the command line. + +``` yaml $(tag) == 'package-2015-10' +input-file: +- Microsoft.Media/stable/2015-10-01/media.json +``` + +### Tag: package-2018-03-preview + +These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-preview' +input-file: +- Microsoft.Media/preview/2018-03-30-preview/Accounts.json +- Microsoft.Media/preview/2018-03-30-preview/Assets.json +- Microsoft.Media/preview/2018-03-30-preview/ContentKeyPolicies.json +- Microsoft.Media/preview/2018-03-30-preview/Encoding.json +- Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json +- Microsoft.Media/preview/2018-03-30-preview/streamingservice.json +``` + +### Tag: package-2018-06-preview + +These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-06-preview' +input-file: +- Microsoft.Media/preview/2018-06-01-preview/Accounts.json +- Microsoft.Media/preview/2018-06-01-preview/Assets.json +- Microsoft.Media/preview/2018-06-01-preview/ContentKeyPolicies.json +- Microsoft.Media/preview/2018-06-01-preview/Encoding.json +- Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json +- Microsoft.Media/preview/2018-06-01-preview/streamingservice.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_media_services'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # last generated from commit 3586e2989d502434c4f607dd38d40e46aabede5c + azure-arm: true + payload-flattening-threshold: 2 + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Media + output-folder: $(csharp-sdks-folder)/Media/Management.Media/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.media + package-name: azure-mgmt-media + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-media/azure/mgmt/media +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-media +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.mediaservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mediaservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-10 + - tag: package-2018-03-preview + - tag: package-2018-06-preview + - tag: package-2018-07 +``` + +### Tag: package-2015-10 and java + +These settings apply only when `--tag=package-2015-10 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2015-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.mediaservices.v2015_10_01 + output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2015_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03-preview and java + +These settings apply only when `--tag=package-2018-03-preview --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.mediaservices.v2018_03_30_preview + output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_03_30_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-06-preview and java + +These settings apply only when `--tag=package-2018-06-preview --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.mediaservices.v2018_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_06_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-07 and java + +These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.mediaservices.v2018_07_01 + output-folder: $(azure-libraries-for-java-folder)/mediaservices/resource-manager/v2018_07_01 +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file 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/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 1154832e5f4f..a4704b19f6fa 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -1,395 +1,395 @@ -# MonitorClient - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for MonitorClient. - ---- - -## Getting Started - -To build the SDK for MonitorClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the MonitorClient API. - -``` yaml -title: MonitorClient -description: Monitor Management Client -openapi-type: arm -tag: package-2019-03 -``` - -### Tag: package-2019-03 - -These settings apply only when `--tag=package-2019-03` is specified on the command line. - -```yaml $(tag) == 'package-2019-03' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2019-03-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -``` - -### Tag: package-2018-11-preview - -These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. - -```yaml $(tag) == 'package-2018-11-preview' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json -``` - -### Tag: package-2018-09 - -These settings apply only when `--tag=package-2018-09` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json -``` - -### Tag: package-2018-03 - -These settings apply only when `--tag=package-2018-03` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-03-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -``` - -### Tag: package-2018-02-preview - -These settings apply only when `--tag=package-2018-02-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-02-preview' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -``` - -### Tag: package-2017-12 - -These settings apply only when `--tag=package-2017-12` is specified on the command line. - -``` yaml $(tag) == 'package-2017-12' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -``` - -### Tag: package-2017-09 - -These settings apply only when `--tag=package-2017-09` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -``` - -### Tag: package-2017-08 - -These settings apply only when `--tag=package-2017-08` is specified on the command line. - -``` yaml $(tag) == 'package-2017-08' -input-file: -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -``` - -### Tag: package-2018-01-01-only - -These settings apply only when `--tag=package-2018-01-01-only` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01-01-only' -input-file: -- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json -- Microsoft.Insights/stable/2018-01-01/metrics_API.json -``` - -### Tag: package-2018-03-01-only - -These settings apply only when `--tag=package-2018-03-01-only` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03-01-only' -input-file: -- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/stable/2018-03-01/actionGroups_API.json -``` - -### Tag: package-2018-04-16-only - -These settings apply only when `--tag=package-2018-04-16-only` is specified on the command line. - -``` yaml $(tag) == 'package-2018-04-16-only' -input-file: -- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json -``` - -### Tag: package-2015-04-01-only - -These settings apply only when `--tag=package-2015-04-01-only` is specified on the command line. - -``` yaml $(tag) == 'package-2015-04-01-only' -input-file: -- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json -- Microsoft.Insights/stable/2015-04-01/autoscale_API.json -- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json -- Microsoft.Insights/stable/2015-04-01/operations_API.json -- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json -``` - -### Tag: package-2016-03-01-only - -These settings apply only when `--tag=package-2016-03-01-only` is specified on the command line. - -``` yaml $(tag) == 'package-2016-03-01-only' -input-file: -- Microsoft.Insights/stable/2016-03-01/alertRules_API.json -- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json -- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json -- Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json -``` - -### Tag: package-2016-09-01-only - -These settings apply only when `--tag=package-2016-09-01-only` is specified on the command line. - -``` yaml $(tag) == 'package-2016-09-01-only' -input-file: -- Microsoft.Insights/stable/2016-09-01/metrics_API.json -- Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json -``` - -### Tag: package-2017-04-01-only - -These settings apply only when `--tag=package-2017-04-01-only` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04-01-only' -input-file: -- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json -- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json -``` - -### Tag: package-2017-05-01-preview-only - -These settings apply only when `--tag=package-2017-05-01-preview-only` is specified on the command line. - -``` yaml $(tag) == 'package-2017-05-01-preview-only' -input-file: -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json -- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json -``` - -### Tag: package-2017-11-01-preview-only - -These settings apply only when `--tag=package-2017-11-01-preview-only` is specified on the command line. - -``` yaml $(tag) == 'package-2017-11-01-preview-only' -input-file: -- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json -- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_monitor'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - payload-flattening-threshold: 1 - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Monitor - output-folder: $(csharp-sdks-folder)/Monitor/Management.Monitor/Generated - clear-output-folder: true -``` - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.monitor -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-monitor -``` - -# Validation - -## Suppression - -``` yaml -directive: - - suppress: R3016 # DefinitionsPropertiesNamesCamelCase (to suppress the error due to odata.type) - reason: The feature (polymorphic types) is in the process of deprecation and fixing this will require changes in the backend. -``` +# MonitorClient + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for MonitorClient. + +--- + +## Getting Started + +To build the SDK for MonitorClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the MonitorClient API. + +``` yaml +title: MonitorClient +description: Monitor Management Client +openapi-type: arm +tag: package-2019-03 +``` + +### Tag: package-2019-03 + +These settings apply only when `--tag=package-2019-03` is specified on the command line. + +```yaml $(tag) == 'package-2019-03' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2019-03-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +``` + +### Tag: package-2018-11-preview + +These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. + +```yaml $(tag) == 'package-2018-11-preview' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +- Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json +``` + +### Tag: package-2018-09 + +These settings apply only when `--tag=package-2018-09` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json +``` + +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-03-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +``` + +### Tag: package-2018-02-preview + +These settings apply only when `--tag=package-2018-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02-preview' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +``` + +### Tag: package-2017-12 + +These settings apply only when `--tag=package-2017-12` is specified on the command line. + +``` yaml $(tag) == 'package-2017-12' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +``` + +### Tag: package-2017-09 + +These settings apply only when `--tag=package-2017-09` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +``` + +### Tag: package-2017-08 + +These settings apply only when `--tag=package-2017-08` is specified on the command line. + +``` yaml $(tag) == 'package-2017-08' +input-file: +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +``` + +### Tag: package-2018-01-01-only + +These settings apply only when `--tag=package-2018-01-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-01-only' +input-file: +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +``` + +### Tag: package-2018-03-01-only + +These settings apply only when `--tag=package-2018-03-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-01-only' +input-file: +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-03-01/actionGroups_API.json +``` + +### Tag: package-2018-04-16-only + +These settings apply only when `--tag=package-2018-04-16-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04-16-only' +input-file: +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +``` + +### Tag: package-2015-04-01-only + +These settings apply only when `--tag=package-2015-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2015-04-01-only' +input-file: +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +``` + +### Tag: package-2016-03-01-only + +These settings apply only when `--tag=package-2016-03-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03-01-only' +input-file: +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json +``` + +### Tag: package-2016-09-01-only + +These settings apply only when `--tag=package-2016-09-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09-01-only' +input-file: +- Microsoft.Insights/stable/2016-09-01/metrics_API.json +- Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json +``` + +### Tag: package-2017-04-01-only + +These settings apply only when `--tag=package-2017-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04-01-only' +input-file: +- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +``` + +### Tag: package-2017-05-01-preview-only + +These settings apply only when `--tag=package-2017-05-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-05-01-preview-only' +input-file: +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json +``` + +### Tag: package-2017-11-01-preview-only + +These settings apply only when `--tag=package-2017-11-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-11-01-preview-only' +input-file: +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_monitor'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + payload-flattening-threshold: 1 + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Monitor + output-folder: $(csharp-sdks-folder)/Monitor/Management.Monitor/Generated + clear-output-folder: true +``` + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.monitor +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-monitor +``` + +# Validation + +## Suppression + +``` yaml +directive: + - suppress: R3016 # DefinitionsPropertiesNamesCamelCase (to suppress the error due to odata.type) + reason: The feature (polymorphic types) is in the process of deprecation and fixing this will require changes in the backend. +``` diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index a5e6226e6371..535b0fee65a1 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -1,150 +1,150 @@ -# MySql - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Sql. - - - ---- -## Getting Started -To build the SDK for MySql, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Sql API. - -``` yaml -openapi-type: arm -tag: package-2017-12-01 -``` - - -### Tag: package-2017-12-01-preview - -These settings apply only when `--tag=package-2017-12-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-12-01-preview' -input-file: -- Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json -``` - - -### Tag: package-2017-12-01 - -These settings apply only when `--tag=package-2017-12-01` is specified on the command line. - -``` yaml $(tag) == 'package-2017-12-01' -input-file: -- Microsoft.DBforMySQL/stable/2017-12-01/mysql.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - - -### C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.MySQL - output-folder: $(csharp-sdks-folder)/MySQL/Management.MySQL/Generated - clear-output-folder: true -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.rdbms.mysql - package-name: azure-mgmt-rdbms - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-rdbms -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.mysql -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mysql -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-12-01 -``` - -### Tag: package-2017-12-01 and java - -These settings apply only when `--tag=package-2017-12-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.mysql.v2017_12_01 - output-folder: $(azure-libraries-for-java-folder)/mysql/resource-manager/v2017_12_01 -regenerate-manager: true -generate-interface: true -``` +# MySql + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Sql. + + + +--- +## Getting Started +To build the SDK for MySql, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Sql API. + +``` yaml +openapi-type: arm +tag: package-2017-12-01 +``` + + +### Tag: package-2017-12-01-preview + +These settings apply only when `--tag=package-2017-12-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-12-01-preview' +input-file: +- Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json +``` + + +### Tag: package-2017-12-01 + +These settings apply only when `--tag=package-2017-12-01` is specified on the command line. + +``` yaml $(tag) == 'package-2017-12-01' +input-file: +- Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + + +### C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.MySQL + output-folder: $(csharp-sdks-folder)/MySQL/Management.MySQL/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.rdbms.mysql + package-name: azure-mgmt-rdbms + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-rdbms/azure/mgmt/rdbms/mysql +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-rdbms +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.mysql +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-mysql +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-12-01 +``` + +### Tag: package-2017-12-01 and java + +These settings apply only when `--tag=package-2017-12-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.mysql.v2017_12_01 + output-folder: $(azure-libraries-for-java-folder)/mysql/resource-manager/v2017_12_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/notificationhubs/resource-manager/readme.md b/specification/notificationhubs/resource-manager/readme.md index e899ead10e8f..b7d165859a1f 100644 --- a/specification/notificationhubs/resource-manager/readme.md +++ b/specification/notificationhubs/resource-manager/readme.md @@ -1,206 +1,206 @@ -# NotificationHubs - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for NotificationHubs. - - - ---- -## Getting Started -To build the SDK for NotificationHubs, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the NotificationHubs API. - -directive: - - where: - - $.definitions.NamespaceCreateOrUpdateParameters - suppress: - - TrackedResourcePatchOperation - - where: - - $.definitions.NamespaceCreateOrUpdateParameters - suppress: - - TrackedResourceGetOperation - -``` yaml -openapi-type: arm -tag: package-2017-04 -directive: - - where: - - $.definitions.NamespaceCreateOrUpdateParameters - suppress: - - TrackedResourcePatchOperation - - TrackedResourceGetOperation -``` - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json -``` - -### Tag: package-2016-03 - -These settings apply only when `--tag=package-2016-03` is specified on the command line. - -``` yaml $(tag) == 'package-2016-03' -input-file: -- Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json -``` - -### Tag: package-2014-09 - -These settings apply only when `--tag=package-2014-09` is specified on the command line. - -``` yaml $(tag) == 'package-2014-09' -input-file: -- Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_notification_hubs'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.NotificationHubs - output-folder: $(csharp-sdks-folder)/NotificationHubs/Management.NotificationHubs/Generated - clear-output-folder: true -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.notificationhubs - package-name: azure-mgmt-notificationhubs - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-notificationhubs/azure/mgmt/notificationhubs -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-notificationhubs -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.notificationhubs -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-notificationhubs -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2014-09 - - tag: package-2017-04 - - tag: package-2016-03 -``` - -### Tag: package-2014-09 and java - -These settings apply only when `--tag=package-2014-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2014-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.notificationhubs.v2014_09_01 - output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2014_09_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.notificationhubs.v2017_04_01 - output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2017_04_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-03 and java - -These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.notificationhubs.v2016_03_01 - output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2016_03_01 -regenerate-manager: true -generate-interface: true -``` - - +# NotificationHubs + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for NotificationHubs. + + + +--- +## Getting Started +To build the SDK for NotificationHubs, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the NotificationHubs API. + +directive: + - where: + - $.definitions.NamespaceCreateOrUpdateParameters + suppress: + - TrackedResourcePatchOperation + - where: + - $.definitions.NamespaceCreateOrUpdateParameters + suppress: + - TrackedResourceGetOperation + +``` yaml +openapi-type: arm +tag: package-2017-04 +directive: + - where: + - $.definitions.NamespaceCreateOrUpdateParameters + suppress: + - TrackedResourcePatchOperation + - TrackedResourceGetOperation +``` + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json +``` + +### Tag: package-2016-03 + +These settings apply only when `--tag=package-2016-03` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03' +input-file: +- Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json +``` + +### Tag: package-2014-09 + +These settings apply only when `--tag=package-2014-09` is specified on the command line. + +``` yaml $(tag) == 'package-2014-09' +input-file: +- Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_notification_hubs'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.NotificationHubs + output-folder: $(csharp-sdks-folder)/NotificationHubs/Management.NotificationHubs/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.notificationhubs + package-name: azure-mgmt-notificationhubs + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-notificationhubs/azure/mgmt/notificationhubs +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-notificationhubs +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.notificationhubs +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-notificationhubs +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2014-09 + - tag: package-2017-04 + - tag: package-2016-03 +``` + +### Tag: package-2014-09 and java + +These settings apply only when `--tag=package-2014-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2014-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.notificationhubs.v2014_09_01 + output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2014_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.notificationhubs.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-03 and java + +These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.notificationhubs.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/notificationhubs/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/operationalinsights/resource-manager/readme.md b/specification/operationalinsights/resource-manager/readme.md index fb8e55278e7c..08e399334edc 100644 --- a/specification/operationalinsights/resource-manager/readme.md +++ b/specification/operationalinsights/resource-manager/readme.md @@ -1,181 +1,181 @@ -# OperationalInsights - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for OperationalInsights. - - - ---- -## Getting Started -To build the SDK for OperationalInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the OperationalInsights API. - -``` yaml -title: OperationalInsightsManagementClient -description: Operational Insights Client -openapi-type: arm -tag: package-2015-11-preview -``` - - -### Tag: package-2015-11-preview - -These settings apply only when `--tag=package-2015-11-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-11-preview' -input-file: -- Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json -``` - -### Tag: package-2015-03 - -These settings apply only when `--tag=package-2015-03` is specified on the command line. - -``` yaml $(tag) == 'package-2015-03' -input-file: -- Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-python - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_operational_insights'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - # last generated using AutoRest.1.0.0-Nightly20170126 - azure-arm: true - namespace: Microsoft.Azure.Management.OperationalInsights - payload-flattening-threshold: 1 - license-header: MICROSOFT_MIT_NO_VERSION - output-folder: $(csharp-sdks-folder)/OperationalInsights/Management/Management.OperationalInsights/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.loganalytics - package-name: azure-mgmt-loganalytics - title: LogAnalyticsManagementClient - description: The Log Analytics Client. - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-loganalytics/azure/mgmt/loganalytics -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-loganalytics -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.operationalinsights -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights -``` - - - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-03 - - tag: package-2015-11-preview -``` - -### Tag: package-2015-03 and java - -These settings apply only when `--tag=package-2015-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.operationalinsights.v2015_03_20 - output-folder: $(azure-libraries-for-java-folder)/operationalinsights/resource-manager/v2015_03_20 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2015-11-preview and java - -These settings apply only when `--tag=package-2015-11-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-11-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.operationalinsights.v2015_11_01_preview - output-folder: $(azure-libraries-for-java-folder)/operationalinsights/resource-manager/v2015_11_01_preview -regenerate-manager: true -generate-interface: true -``` - - -## Suppression - -``` yaml -directive: - - from: OperationalInsights.json - suppress: R3006 # BodyTopLevelProperties/R3006/RPCViolation - reason: properties etag defined as eTag in model -``` +# OperationalInsights + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for OperationalInsights. + + + +--- +## Getting Started +To build the SDK for OperationalInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the OperationalInsights API. + +``` yaml +title: OperationalInsightsManagementClient +description: Operational Insights Client +openapi-type: arm +tag: package-2015-11-preview +``` + + +### Tag: package-2015-11-preview + +These settings apply only when `--tag=package-2015-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-11-preview' +input-file: +- Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json +``` + +### Tag: package-2015-03 + +These settings apply only when `--tag=package-2015-03` is specified on the command line. + +``` yaml $(tag) == 'package-2015-03' +input-file: +- Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_operational_insights'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + # last generated using AutoRest.1.0.0-Nightly20170126 + azure-arm: true + namespace: Microsoft.Azure.Management.OperationalInsights + payload-flattening-threshold: 1 + license-header: MICROSOFT_MIT_NO_VERSION + output-folder: $(csharp-sdks-folder)/OperationalInsights/Management/Management.OperationalInsights/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.loganalytics + package-name: azure-mgmt-loganalytics + title: LogAnalyticsManagementClient + description: The Log Analytics Client. + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-loganalytics/azure/mgmt/loganalytics +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-loganalytics +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.operationalinsights +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights +``` + + + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-03 + - tag: package-2015-11-preview +``` + +### Tag: package-2015-03 and java + +These settings apply only when `--tag=package-2015-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.operationalinsights.v2015_03_20 + output-folder: $(azure-libraries-for-java-folder)/operationalinsights/resource-manager/v2015_03_20 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-11-preview and java + +These settings apply only when `--tag=package-2015-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-11-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.operationalinsights.v2015_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/operationalinsights/resource-manager/v2015_11_01_preview +regenerate-manager: true +generate-interface: true +``` + + +## Suppression + +``` yaml +directive: + - from: OperationalInsights.json + suppress: R3006 # BodyTopLevelProperties/R3006/RPCViolation + reason: properties etag defined as eTag in model +``` diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScope.json index e3400da6b7c9..96e788c245b7 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScope.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScope.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "managementGroupsNamespace": "Microsoft.Management", - "managementGroupName": "myManagementGroup", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName1", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", - "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - }, - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName2", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName1", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", + "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + }, + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName2", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json index 8f8468c8d746..1ff3cb7b3702 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "managementGroupsNamespace": "Microsoft.Management", - "managementGroupName": "myManagementGroup", - "api-version": "2018-07-01-preview", - "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName'", - "$top": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "policyAssignmentDisplayName": "My Policy Assignment Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2018-07-01-preview", + "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyAssignmentDisplayName": "My Policy Assignment Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScope.json index c506e2c184ff..970eb5c8e595 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScope.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScope.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName1", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", - "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - }, - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName2", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName1", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", + "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + }, + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName2", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json index 6d23d328c9e3..984d420fe97a 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json @@ -1,48 +1,48 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-07-01-preview", - "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1'", - "$top": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", - "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-07-01-preview", + "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", + "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScope.json index 254c1312e1cd..5c1eca9e90fe 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScope.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScope.json @@ -1,54 +1,54 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "resourceId": "subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", - "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - }, - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource2", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "resourceId": "subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", + "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + }, + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource2", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json index 7ee570601d46..11a4ecc335f6 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "resourceId": "subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource", - "api-version": "2018-07-01-preview", - "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1'", - "$top": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", - "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "resourceId": "subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource", + "api-version": "2018-07-01-preview", + "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/myResource/nestedResourceType/TrackedResource1", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", + "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScope.json index 6b65880e1fac..cefd0c5eb5c4 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScope.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScope.json @@ -1,54 +1,54 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", - "api-version": "2018-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName1", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", - "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - }, - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName2", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName1", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition1", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment1", + "policyAssignmentDisplayName": "My Policy Assignment 1 Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + }, + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName2", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition2", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "lastUpdateUtc": "2018-08-10T00:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json index 6752e4f319a5..2be5370c44c1 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json @@ -1,47 +1,47 @@ -{ - "parameters": { - "policyTrackedResourcesResource": "default", - "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", - "api-version": "2018-07-01-preview", - "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName'", - "$top": 1 - }, - "responses": { - "200": { - "body": { - "value": [ - { - "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName", - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "policyAssignmentDisplayName": "My Policy Assignment Display name", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", - "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", - "policyDefinitionReferenceId": "123ABC" - }, - "createdBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-03-09T00:00:00.0000000Z" - }, - "lastModifiedBy": { - "policyDetails": { - "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", - "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", - "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" - }, - "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", - "deploymentTime" : "2018-04-09T00:00:00.0000000Z" - }, - "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" - } - ] - } - } - } -} +{ + "parameters": { + "policyTrackedResourcesResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2018-07-01-preview", + "$filter": "PolicyAssignmentId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment' AND TrackedResourceId eq '/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "trackedResourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Example/exampleResourceType/exampleTrackedResourceName", + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/myPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyAssignmentDisplayName": "My Policy Assignment Display name", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/", + "policySetDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/providers/Microsoft.Authorization/policySetDefinitions/mySetDefinition", + "policyDefinitionReferenceId": "123ABC" + }, + "createdBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/createdByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/createdByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-03-09T00:00:00.0000000Z" + }, + "lastModifiedBy": { + "policyDetails": { + "policyDefinitionId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyDefinitions/lastModifiedByPolicyDefinition", + "policyAssignmentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/lastModifiedByPolicyAssignment", + "policyAssignmentScope": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/" + }, + "deploymentId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myResourceGroup/providers/Microsoft.Resources/deployments/deploymentName", + "deploymentTime" : "2018-04-09T00:00:00.0000000Z" + }, + "lastUpdateUtc": "2018-08-09T20:40:17.3585243Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json index db31a40e2bea..728d607618f3 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json @@ -1,452 +1,452 @@ -{ - "swagger": "2.0", - "info": { - "title": "PolicyTrackedResourcesClient", - "version": "2018-07-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "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/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { - "post": { - "operationId": "PolicyTrackedResources_ListQueryResultsForManagementGroup", - "description": "Queries policy tracked resources under the management group.", - "parameters": [ - { - "$ref": "#/parameters/managementGroupsNamespaceParameter" - }, - { - "$ref": "#/parameters/managementGroupNameParameter" - }, - { - "$ref": "#/parameters/policyTrackedResourcesResourceParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Query results.", - "schema": { - "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/QueryFailure" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Query at management group scope": { - "$ref": "./examples/PolicyTrackedResources_QueryManagementGroupScope.json" - }, - "Query at management group scope using query parameters": { - "$ref": "./examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { - "post": { - "operationId": "PolicyTrackedResources_ListQueryResultsForSubscription", - "description": "Queries policy tracked resources under the subscription.", - "parameters": [ - { - "$ref": "#/parameters/policyTrackedResourcesResourceParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Query results.", - "schema": { - "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/QueryFailure" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Query at subscription scope": { - "$ref": "./examples/PolicyTrackedResources_QuerySubscriptionScope.json" - }, - "Query at subscription scope using query parameters": { - "$ref": "./examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { - "post": { - "operationId": "PolicyTrackedResources_ListQueryResultsForResourceGroup", - "description": "Queries policy tracked resources under the resource group.", - "parameters": [ - { - "$ref": "#/parameters/resourceGroupNameParameter" - }, - { - "$ref": "#/parameters/policyTrackedResourcesResourceParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/subscriptionIdParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Query results.", - "schema": { - "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/QueryFailure" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Query at resource group scope": { - "$ref": "./examples/PolicyTrackedResources_QueryResourceGroupScope.json" - }, - "Query at resource group scope using query parameters": { - "$ref": "./examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json" - } - } - } - }, - "/{resourceId}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { - "post": { - "operationId": "PolicyTrackedResources_ListQueryResultsForResource", - "description": "Queries policy tracked resources under the resource.", - "parameters": [ - { - "$ref": "#/parameters/resourceIdParameter" - }, - { - "$ref": "#/parameters/policyTrackedResourcesResourceParameter" - }, - { - "$ref": "#/parameters/topParameter" - }, - { - "$ref": "#/parameters/filterParameter" - }, - { - "$ref": "#/parameters/apiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Query results.", - "schema": { - "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/QueryFailure" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Query at resource scope": { - "$ref": "./examples/PolicyTrackedResources_QueryResourceScope.json" - }, - "Query at resource scope using query parameters": { - "$ref": "./examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json" - } - } - } - } - }, - "definitions": { - "PolicyTrackedResourcesQueryResults": { - "description": "Query results.", - "properties": { - "value": { - "description": "Query results.", - "type": "array", - "items": { - "$ref": "#/definitions/PolicyTrackedResource" - }, - "readOnly": true - }, - "nextLink": { - "type": "string", - "description": "The URL to get the next set of results.", - "readOnly": true - } - } - }, - "PolicyTrackedResource": { - "type": "object", - "description": "Policy tracked resource record.", - "properties": { - "trackedResourceId": { - "description": "The ID of the policy tracked resource.", - "type": "string", - "readOnly": true - }, - "policyDetails": { - "$ref": "#/definitions/PolicyDetails", - "description": "The details of the policy that require the tracked resource.", - "readOnly": true - }, - "createdBy": { - "$ref": "#/definitions/TrackedResourceModificationDetails", - "description": "The details of the policy triggered deployment that created the tracked resource.", - "readOnly": true - }, - "lastModifiedBy": { - "$ref": "#/definitions/TrackedResourceModificationDetails", - "description": "The details of the policy triggered deployment that modified the tracked resource.", - "readOnly": true - }, - "lastUpdateUtc": { - "description": "Timestamp of the last update to the tracked resource.", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - }, - "TrackedResourceModificationDetails": { - "type": "object", - "description": "The details of the policy triggered deployment that created or modified the tracked resource.", - "properties": { - "policyDetails": { - "$ref": "#/definitions/PolicyDetails", - "description": "The details of the policy that created or modified the tracked resource.", - "readOnly": true - }, - "deploymentId": { - "description": "The ID of the deployment that created or modified the tracked resource.", - "type": "string", - "readOnly": true - }, - "deploymentTime": { - "description": "Timestamp of the deployment that created or modified the tracked resource.", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - }, - "PolicyDetails": { - "type": "object", - "description": "The policy details.", - "properties": { - "policyDefinitionId": { - "description": "The ID of the policy definition.", - "type": "string", - "readOnly": true - }, - "policyAssignmentId": { - "description": "The ID of the policy assignment.", - "type": "string", - "readOnly": true - }, - "policyAssignmentDisplayName": { - "description": "The display name of the policy assignment.", - "type": "string", - "readOnly": true - }, - "policyAssignmentScope": { - "description": "The scope of the policy assignment.", - "type": "string", - "readOnly": true - }, - "policySetDefinitionId": { - "description": "The ID of the policy set definition.", - "type": "string", - "readOnly": true - }, - "policyDefinitionReferenceId": { - "description": "The policy definition reference ID within the policy set definition.", - "type": "string", - "readOnly": true - } - } - }, - "QueryFailure": { - "description": "Error response.", - "properties": { - "error": { - "description": "Error definition.", - "properties": { - "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Description of the error.", - "type": "string", - "readOnly": true - } - } - } - } - } - }, - "parameters": { - "policyTrackedResourcesResourceParameter": { - "name": "policyTrackedResourcesResource", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "description": "The name of the virtual resource under PolicyTrackedResources resource type; only \"default\" is allowed.", - "x-ms-parameter-location": "method" - }, - "managementGroupsNamespaceParameter": { - "name": "managementGroupsNamespace", - "in": "path", - "required": true, - "type": "string", - "enum": [ - "Microsoft.Management" - ], - "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", - "x-ms-parameter-location": "method" - }, - "managementGroupNameParameter": { - "name": "managementGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Management group name.", - "x-ms-parameter-location": "method" - }, - "resourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Resource group name.", - "x-ms-parameter-location": "method" - }, - "resourceIdParameter": { - "name": "resourceId", - "in": "path", - "required": true, - "type": "string", - "description": "Resource ID.", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true - }, - "topParameter": { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32", - "minimum": 0, - "description": "Maximum number of records to return.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Top" - }, - "filterParameter": { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression.", - "x-ms-parameter-location": "method", - "x-ms-parameter-grouping": { - "name": "QueryOptions" - }, - "x-ms-client-name": "Filter" - }, - "subscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Microsoft Azure subscription ID." - }, - "apiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version.", - "x-ms-parameter-location": "client" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "PolicyTrackedResourcesClient", + "version": "2018-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "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/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { + "post": { + "operationId": "PolicyTrackedResources_ListQueryResultsForManagementGroup", + "description": "Queries policy tracked resources under the management group.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupNameParameter" + }, + { + "$ref": "#/parameters/policyTrackedResourcesResourceParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Query at management group scope": { + "$ref": "./examples/PolicyTrackedResources_QueryManagementGroupScope.json" + }, + "Query at management group scope using query parameters": { + "$ref": "./examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { + "post": { + "operationId": "PolicyTrackedResources_ListQueryResultsForSubscription", + "description": "Queries policy tracked resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/policyTrackedResourcesResourceParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Query at subscription scope": { + "$ref": "./examples/PolicyTrackedResources_QuerySubscriptionScope.json" + }, + "Query at subscription scope using query parameters": { + "$ref": "./examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { + "post": { + "operationId": "PolicyTrackedResources_ListQueryResultsForResourceGroup", + "description": "Queries policy tracked resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/policyTrackedResourcesResourceParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Query at resource group scope": { + "$ref": "./examples/PolicyTrackedResources_QueryResourceGroupScope.json" + }, + "Query at resource group scope using query parameters": { + "$ref": "./examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults": { + "post": { + "operationId": "PolicyTrackedResources_ListQueryResultsForResource", + "description": "Queries policy tracked resources under the resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/policyTrackedResourcesResourceParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyTrackedResourcesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Query at resource scope": { + "$ref": "./examples/PolicyTrackedResources_QueryResourceScope.json" + }, + "Query at resource scope using query parameters": { + "$ref": "./examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json" + } + } + } + } + }, + "definitions": { + "PolicyTrackedResourcesQueryResults": { + "description": "Query results.", + "properties": { + "value": { + "description": "Query results.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyTrackedResource" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + } + }, + "PolicyTrackedResource": { + "type": "object", + "description": "Policy tracked resource record.", + "properties": { + "trackedResourceId": { + "description": "The ID of the policy tracked resource.", + "type": "string", + "readOnly": true + }, + "policyDetails": { + "$ref": "#/definitions/PolicyDetails", + "description": "The details of the policy that require the tracked resource.", + "readOnly": true + }, + "createdBy": { + "$ref": "#/definitions/TrackedResourceModificationDetails", + "description": "The details of the policy triggered deployment that created the tracked resource.", + "readOnly": true + }, + "lastModifiedBy": { + "$ref": "#/definitions/TrackedResourceModificationDetails", + "description": "The details of the policy triggered deployment that modified the tracked resource.", + "readOnly": true + }, + "lastUpdateUtc": { + "description": "Timestamp of the last update to the tracked resource.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "TrackedResourceModificationDetails": { + "type": "object", + "description": "The details of the policy triggered deployment that created or modified the tracked resource.", + "properties": { + "policyDetails": { + "$ref": "#/definitions/PolicyDetails", + "description": "The details of the policy that created or modified the tracked resource.", + "readOnly": true + }, + "deploymentId": { + "description": "The ID of the deployment that created or modified the tracked resource.", + "type": "string", + "readOnly": true + }, + "deploymentTime": { + "description": "Timestamp of the deployment that created or modified the tracked resource.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "PolicyDetails": { + "type": "object", + "description": "The policy details.", + "properties": { + "policyDefinitionId": { + "description": "The ID of the policy definition.", + "type": "string", + "readOnly": true + }, + "policyAssignmentId": { + "description": "The ID of the policy assignment.", + "type": "string", + "readOnly": true + }, + "policyAssignmentDisplayName": { + "description": "The display name of the policy assignment.", + "type": "string", + "readOnly": true + }, + "policyAssignmentScope": { + "description": "The scope of the policy assignment.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionId": { + "description": "The ID of the policy set definition.", + "type": "string", + "readOnly": true + }, + "policyDefinitionReferenceId": { + "description": "The policy definition reference ID within the policy set definition.", + "type": "string", + "readOnly": true + } + } + }, + "QueryFailure": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + } + } + } + } + } + }, + "parameters": { + "policyTrackedResourcesResourceParameter": { + "name": "policyTrackedResourcesResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "description": "The name of the virtual resource under PolicyTrackedResources resource type; only \"default\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupsNamespaceParameter": { + "name": "managementGroupsNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Management" + ], + "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Management group name.", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name.", + "x-ms-parameter-location": "method" + }, + "resourceIdParameter": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Microsoft Azure subscription ID." + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 3053b1935403..8687220bb1a1 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -1,150 +1,150 @@ -# PostgreSQL - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Sql. - - - ---- -## Getting Started -To build the SDK for PostgreSQLPostgreSQL, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Sql API. - -``` yaml -openapi-type: arm -tag: package-2017-12-01 -``` - - -### Tag: package-2017-12-01-preview - -These settings apply only when `--tag=package-2017-12-01-preview` is specified on the command line. - - -``` yaml $(tag) == 'package-2017-12-01-preview' -input-file: -- Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json -``` - -### Tag: package-2017-12-01 - -These settings apply only when `--tag=package-2017-12-01` is specified on the command line. - - -``` yaml $(tag) == 'package-2017-12-01' -input-file: -- Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -### C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.PostgreSQL - output-folder: $(csharp-sdks-folder)/PostgreSQL/Management.PostgreSQL/Generated - clear-output-folder: true -``` - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.rdbms.postgresql - package-name: azure-mgmt-rdbms - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-rdbms -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.postgresql -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-postgresql -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-12-01 -``` - -### Tag: package-2017-12-01 and java - -These settings apply only when `--tag=package-2016-12-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.postgresql.v2017_12_01 - output-folder: $(azure-libraries-for-java-folder)/postgresql/resource-manager/v2017_12_01 -regenerate-manager: true -generate-interface: true -``` +# PostgreSQL + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Sql. + + + +--- +## Getting Started +To build the SDK for PostgreSQLPostgreSQL, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Sql API. + +``` yaml +openapi-type: arm +tag: package-2017-12-01 +``` + + +### Tag: package-2017-12-01-preview + +These settings apply only when `--tag=package-2017-12-01-preview` is specified on the command line. + + +``` yaml $(tag) == 'package-2017-12-01-preview' +input-file: +- Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json +``` + +### Tag: package-2017-12-01 + +These settings apply only when `--tag=package-2017-12-01` is specified on the command line. + + +``` yaml $(tag) == 'package-2017-12-01' +input-file: +- Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +### C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.PostgreSQL + output-folder: $(csharp-sdks-folder)/PostgreSQL/Management.PostgreSQL/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.rdbms.postgresql + package-name: azure-mgmt-rdbms + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-rdbms/azure/mgmt/rdbms/postgresql +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-rdbms +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.postgresql +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-postgresql +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-12-01 +``` + +### Tag: package-2017-12-01 and java + +These settings apply only when `--tag=package-2016-12-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-12-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.postgresql.v2017_12_01 + output-folder: $(azure-libraries-for-java-folder)/postgresql/resource-manager/v2017_12_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/powerbiembedded/resource-manager/readme.md b/specification/powerbiembedded/resource-manager/readme.md index b0288b2b8454..45b1a1864882 100644 --- a/specification/powerbiembedded/resource-manager/readme.md +++ b/specification/powerbiembedded/resource-manager/readme.md @@ -1,145 +1,145 @@ -# PowerBI - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for PowerBI. - - - ---- -## Getting Started -To build the SDK for PowerBI, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the PowerBI API. - -``` yaml -openapi-type: arm -tag: package-2016-01 -``` - - -### Tag: package-2016-01 - -These settings apply only when `--tag=package-2016-01` is specified on the command line. - -``` yaml $(tag) == 'package-2016-01' -input-file: -- Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_powerbi_embedded'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.PowerBIEmbedded - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/PowerBIEmbedded/Management.PowerBIEmbedded/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.powerbiembedded - package-name: azure-mgmt-powerbiembedded - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-powerbiembedded/azure/mgmt/powerbiembedded -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-powerbiembedded -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.powerbiembedded -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-powerbiembedded -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-01 -``` - -### Tag: package-2016-01 and java - -These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.powerbi.v2016_01_29 - output-folder: $(azure-libraries-for-java-folder)/powerbi/resource-manager/v2016_01_29 -regenerate-manager: true -generate-interface: true -``` - - +# PowerBI + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for PowerBI. + + + +--- +## Getting Started +To build the SDK for PowerBI, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the PowerBI API. + +``` yaml +openapi-type: arm +tag: package-2016-01 +``` + + +### Tag: package-2016-01 + +These settings apply only when `--tag=package-2016-01` is specified on the command line. + +``` yaml $(tag) == 'package-2016-01' +input-file: +- Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_powerbi_embedded'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.PowerBIEmbedded + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/PowerBIEmbedded/Management.PowerBIEmbedded/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.powerbiembedded + package-name: azure-mgmt-powerbiembedded + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-powerbiembedded/azure/mgmt/powerbiembedded +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-powerbiembedded +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.powerbiembedded +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-powerbiembedded +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-01 +``` + +### Tag: package-2016-01 and java + +These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.powerbi.v2016_01_29 + output-folder: $(azure-libraries-for-java-folder)/powerbi/resource-manager/v2016_01_29 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/privatedns/resource-manager/readme.md b/specification/privatedns/resource-manager/readme.md index 3d4b17011c38..40c5d7e8b4f0 100644 --- a/specification/privatedns/resource-manager/readme.md +++ b/specification/privatedns/resource-manager/readme.md @@ -1,135 +1,135 @@ -# Private DNS - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Private DNS. - ---- - -## Getting Started - -To build the SDK for Private DNS, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the Private DNS API. - -``` yaml -openapi-type: arm -tag: package-2018-09 -``` - -### Tag: package-2018-09 - -These settings apply only when `--tag=package-2018-09` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09' -input-file: - - Microsoft.Network/stable/2018-09-01/privatedns.json -``` - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.PrivateDns - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/PrivateDns/Management.PrivateDns/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.privatedns -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-privatedns -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-09 -``` - -### Tag: package-2018-09 and java - -These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.privatedns.v2018_09_01 - output-folder: $(azure-libraries-for-java-folder)/privatedns/resource-manager/v2018_09_01 -regenerate-manager: true -generate-interface: true -fconfig: '{"moduleName": "privatedns"}' -``` - -## Suppression - -``` yaml -directive: - - where: $.paths - from: privatedns.json - suppress: OperationsAPIImplementation - reason: Operation APIs for Microsoft.Network are to be defined in Network swagger. - - where: $.definitions.VirtualNetworkLinkProperties.properties.registrationEnabled - from: privatedns.json - suppress: EnumInsteadOfBoolean - reason: Booleans are used to indicate binary states of the property, enum is not appropriate. - - where: $.definitions.RecordSetProperties.properties.isAutoRegistered - from: privatedns.json - suppress: EnumInsteadOfBoolean - reason: Booleans are used to indicate binary states of the property, enum is not appropriate. - - where: $.definitions - from: privatedns.json - suppress: TrackedResourceListByImmediateParent - reason: Another list API naming approach is used over the specs. - - where: $.definitions.Resource - from: types.json - suppress: DescriptionAndTitleMissing - reason: Common types warning. -``` +# Private DNS + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Private DNS. + +--- + +## Getting Started + +To build the SDK for Private DNS, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Private DNS API. + +``` yaml +openapi-type: arm +tag: package-2018-09 +``` + +### Tag: package-2018-09 + +These settings apply only when `--tag=package-2018-09` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09' +input-file: + - Microsoft.Network/stable/2018-09-01/privatedns.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.PrivateDns + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/PrivateDns/Management.PrivateDns/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.privatedns +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-privatedns +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09 +``` + +### Tag: package-2018-09 and java + +These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.privatedns.v2018_09_01 + output-folder: $(azure-libraries-for-java-folder)/privatedns/resource-manager/v2018_09_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "privatedns"}' +``` + +## Suppression + +``` yaml +directive: + - where: $.paths + from: privatedns.json + suppress: OperationsAPIImplementation + reason: Operation APIs for Microsoft.Network are to be defined in Network swagger. + - where: $.definitions.VirtualNetworkLinkProperties.properties.registrationEnabled + from: privatedns.json + suppress: EnumInsteadOfBoolean + reason: Booleans are used to indicate binary states of the property, enum is not appropriate. + - where: $.definitions.RecordSetProperties.properties.isAutoRegistered + from: privatedns.json + suppress: EnumInsteadOfBoolean + reason: Booleans are used to indicate binary states of the property, enum is not appropriate. + - where: $.definitions + from: privatedns.json + suppress: TrackedResourceListByImmediateParent + reason: Another list API naming approach is used over the specs. + - where: $.definitions.Resource + from: types.json + suppress: DescriptionAndTitleMissing + reason: Common types warning. +``` diff --git a/specification/recoveryservices/resource-manager/readme.md b/specification/recoveryservices/resource-manager/readme.md index 5c7a92ad9e24..0441bbd73928 100644 --- a/specification/recoveryservices/resource-manager/readme.md +++ b/specification/recoveryservices/resource-manager/readme.md @@ -1,159 +1,159 @@ -# RecoveryServices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for RecoveryServices. - - - ---- -## Getting Started -To build the SDK for RecoveryServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the RecoveryServices API. - -``` yaml -title: RecoveryServicesClient -description: Recovery Services Client -openapi-type: arm -tag: package-2016-06 -``` - -### Validations -Run validations when `--validate` is specified on command line - -``` yaml $(validate) -azure-validator: true -model-validator: true -semantic-validator: true -message-format: json -``` - -### Tag: package-2016-06 - -These settings apply only when `--tag=package-2016-06` is specified on the command line. - -``` yaml $(tag) == 'package-2016-06' -input-file: -- Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json -- Microsoft.RecoveryServices/stable/2016-06-01/replicationusages.json -- Microsoft.RecoveryServices/stable/2016-06-01/vaults.json -- Microsoft.RecoveryServices/stable/2016-06-01/vaultusages.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 1 - namespace: Microsoft.Azure.Management.RecoveryServices - output-folder: $(csharp-sdks-folder)/RecoveryServices/Management.RecoveryServices/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.recoveryservices - package-name: azure-mgmt-recoveryservices - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservices/azure/mgmt/recoveryservices -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservices -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.recoveryservices -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservices -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-06 -``` - -### Tag: package-2016-06 and java - -These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.recoveryservices.v2016_06_01 - output-folder: $(azure-libraries-for-java-folder)/recoveryservices/resource-manager/v2016_06_01 -regenerate-manager: true -generate-interface: true -``` - - +# RecoveryServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for RecoveryServices. + + + +--- +## Getting Started +To build the SDK for RecoveryServices, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the RecoveryServices API. + +``` yaml +title: RecoveryServicesClient +description: Recovery Services Client +openapi-type: arm +tag: package-2016-06 +``` + +### Validations +Run validations when `--validate` is specified on command line + +``` yaml $(validate) +azure-validator: true +model-validator: true +semantic-validator: true +message-format: json +``` + +### Tag: package-2016-06 + +These settings apply only when `--tag=package-2016-06` is specified on the command line. + +``` yaml $(tag) == 'package-2016-06' +input-file: +- Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json +- Microsoft.RecoveryServices/stable/2016-06-01/replicationusages.json +- Microsoft.RecoveryServices/stable/2016-06-01/vaults.json +- Microsoft.RecoveryServices/stable/2016-06-01/vaultusages.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 1 + namespace: Microsoft.Azure.Management.RecoveryServices + output-folder: $(csharp-sdks-folder)/RecoveryServices/Management.RecoveryServices/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.recoveryservices + package-name: azure-mgmt-recoveryservices + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservices/azure/mgmt/recoveryservices +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservices +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.recoveryservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-06 +``` + +### Tag: package-2016-06 and java + +These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.recoveryservices.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/recoveryservices/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/recoveryservicesbackup/resource-manager/readme.md b/specification/recoveryservicesbackup/resource-manager/readme.md index d410c097801a..89640a75a743 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.md @@ -1,198 +1,198 @@ -# RecoveryServices.Backup - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for RecoveryServicesBackup. - - - ---- -## Getting Started -To build the SDK for RecoveryServicesBackup, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the RecoveryServicesBackup API. - -``` yaml -title: Recovery Services Backup Client -description: Open API 2.0 Specs for Azure RecoveryServices Backup service -openapi-type: arm -tag: package-2017-07 -csharp-sdks-folder: ./Generated/CSharp -python-sdks-folder: ./Generated/Python -go-sdk-folder: ./Generated/Golang - -license-header: MICROSOFT_MIT -``` - -### Validations -Run validations when `--validate` is specified on command line - -``` yaml $(validate) -azure-validator: true -model-validator: true -semantic-validator: true -message-format: json -``` - -### Tag: package-2017-07 - -These settings apply only when `--tag=package-2017-07` is specified on the command line. - -``` yaml $(tag) == 'package-2017-07' -input-file: -- Microsoft.RecoveryServices/stable/2017-07-01/bms.json -- Microsoft.RecoveryServices/stable/2016-12-01/bms.json -- Microsoft.RecoveryServices/stable/2016-08-10/operations.json -``` - -### Tag: package-2016-06 - -These settings apply only when `--tag=package-2016-06` is specified on the command line. - -``` yaml $(tag) == 'package-2016-06' -input-file: -- Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json -- Microsoft.RecoveryServices/stable/2016-06-01/registeredIdentities.json -``` - -### Tag: package-2016-08 - -These settings apply only when `--tag=package-2016-08` is specified on the command line. - -``` yaml $(tag) == 'package-2016-08' -input-file: -- Microsoft.RecoveryServices/stable/2016-08-10/operations.json -``` - -### Tag: package-2016-12 - -These settings apply only when `--tag=package-2016-12` is specified on the command line. - -``` yaml $(tag) == 'package-2016-12' -input-file: -- Microsoft.RecoveryServices/stable/2016-12-01/bms.json -``` - -### Tag: package-2017-07-only - -These settings apply only when `--tag=package-2017-07` is specified on the command line. - -``` yaml $(tag) == 'package-2017-07-only' -input-file: -- Microsoft.RecoveryServices/stable/2017-07-01/bms.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services_backup'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - azure-arm: true - payload-flattening-threshold: 1 - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.RecoveryServices.Backup - output-folder: $(csharp-sdks-folder)/RecoveryServices.Backup/Management.RecoveryServices.Backup/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.recoveryservicesbackup - package-name: azure-mgmt-recoveryservicesbackup - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservicesbackup/azure/mgmt/recoveryservicesbackup -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservicesbackup -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.recoveryservicesbackup -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicesbackup -``` - - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-06 -``` - -### Tag: package-2016-06 and java - -These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.recoveryservices.backup.v2016_06_01 - output-folder: $(azure-libraries-for-java-folder)/recoveryservices.backup/resource-manager/v2016_06_01 -regenerate-manager: true -generate-interface: true -``` +# RecoveryServices.Backup + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for RecoveryServicesBackup. + + + +--- +## Getting Started +To build the SDK for RecoveryServicesBackup, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the RecoveryServicesBackup API. + +``` yaml +title: Recovery Services Backup Client +description: Open API 2.0 Specs for Azure RecoveryServices Backup service +openapi-type: arm +tag: package-2017-07 +csharp-sdks-folder: ./Generated/CSharp +python-sdks-folder: ./Generated/Python +go-sdk-folder: ./Generated/Golang + +license-header: MICROSOFT_MIT +``` + +### Validations +Run validations when `--validate` is specified on command line + +``` yaml $(validate) +azure-validator: true +model-validator: true +semantic-validator: true +message-format: json +``` + +### Tag: package-2017-07 + +These settings apply only when `--tag=package-2017-07` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07' +input-file: +- Microsoft.RecoveryServices/stable/2017-07-01/bms.json +- Microsoft.RecoveryServices/stable/2016-12-01/bms.json +- Microsoft.RecoveryServices/stable/2016-08-10/operations.json +``` + +### Tag: package-2016-06 + +These settings apply only when `--tag=package-2016-06` is specified on the command line. + +``` yaml $(tag) == 'package-2016-06' +input-file: +- Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json +- Microsoft.RecoveryServices/stable/2016-06-01/registeredIdentities.json +``` + +### Tag: package-2016-08 + +These settings apply only when `--tag=package-2016-08` is specified on the command line. + +``` yaml $(tag) == 'package-2016-08' +input-file: +- Microsoft.RecoveryServices/stable/2016-08-10/operations.json +``` + +### Tag: package-2016-12 + +These settings apply only when `--tag=package-2016-12` is specified on the command line. + +``` yaml $(tag) == 'package-2016-12' +input-file: +- Microsoft.RecoveryServices/stable/2016-12-01/bms.json +``` + +### Tag: package-2017-07-only + +These settings apply only when `--tag=package-2017-07` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07-only' +input-file: +- Microsoft.RecoveryServices/stable/2017-07-01/bms.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services_backup'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +```yaml $(csharp) +csharp: + azure-arm: true + payload-flattening-threshold: 1 + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.RecoveryServices.Backup + output-folder: $(csharp-sdks-folder)/RecoveryServices.Backup/Management.RecoveryServices.Backup/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.recoveryservicesbackup + package-name: azure-mgmt-recoveryservicesbackup + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservicesbackup/azure/mgmt/recoveryservicesbackup +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-recoveryservicesbackup +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.recoveryservicesbackup +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicesbackup +``` + + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-06 +``` + +### Tag: package-2016-06 and java + +These settings apply only when `--tag=package-2016-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.recoveryservices.backup.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/recoveryservices.backup/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/recoveryservicessiterecovery/resource-manager/readme.md b/specification/recoveryservicessiterecovery/resource-manager/readme.md index d2ea86fd9313..d89554a55f1a 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/readme.md +++ b/specification/recoveryservicessiterecovery/resource-manager/readme.md @@ -1,131 +1,131 @@ -# RecoveryServicesSiteRecovery - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for RecoveryServicesSiteRecovery. - ---- - -## Getting Started - -To build the SDK for RecoveryServicesSiteRecovery, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the RecoveryServicesSiteRecovery API. - -``` yaml -openapi-type: arm -tag: package-2018-07 -``` - - -### Tag: package-2018-07 - -These settings apply only when `--tag=package-2018-07` is specified on the command line. - -```yaml $(tag) == 'package-2018-07' -input-file: - - Microsoft.RecoveryServices/stable/2018-07-10/service.json -``` -### Tag: package-2016-08 - -These settings apply only when `--tag=package-2018-01` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01' -input-file: -- Microsoft.RecoveryServices/stable/2018-01-10/service.json -``` - -### Tag: package-2016-08 - -These settings apply only when `--tag=package-2016-08` is specified on the command line. - -``` yaml $(tag) == 'package-2016-08' -input-file: -- Microsoft.RecoveryServices/stable/2016-08-10/service.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services_site_recovery'] -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - payload-flattening-threshold: 0 - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.RecoveryServices.SiteRecovery - output-folder: $(csharp-sdks-folder)/RecoveryServices.SiteRecovery/Management.RecoveryServices.SiteRecovery/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.recoveryservicessiterecovery -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicessiterecovery -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-08 -``` - -### Tag: package-2016-08 and java - -These settings apply only when `--tag=package-2016-08 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-08' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.recoveryservicessiterecovery.v2018_01_10 - output-folder: $(azure-libraries-for-java-folder)/recoveryservicessiterecovery/resource-manager/v2018_01_10 -regenerate-manager: true -generate-interface: true -``` +# RecoveryServicesSiteRecovery + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for RecoveryServicesSiteRecovery. + +--- + +## Getting Started + +To build the SDK for RecoveryServicesSiteRecovery, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the RecoveryServicesSiteRecovery API. + +``` yaml +openapi-type: arm +tag: package-2018-07 +``` + + +### Tag: package-2018-07 + +These settings apply only when `--tag=package-2018-07` is specified on the command line. + +```yaml $(tag) == 'package-2018-07' +input-file: + - Microsoft.RecoveryServices/stable/2018-07-10/service.json +``` +### Tag: package-2016-08 + +These settings apply only when `--tag=package-2018-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01' +input-file: +- Microsoft.RecoveryServices/stable/2018-01-10/service.json +``` + +### Tag: package-2016-08 + +These settings apply only when `--tag=package-2016-08` is specified on the command line. + +``` yaml $(tag) == 'package-2016-08' +input-file: +- Microsoft.RecoveryServices/stable/2016-08-10/service.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_recovery_services_site_recovery'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + payload-flattening-threshold: 0 + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.RecoveryServices.SiteRecovery + output-folder: $(csharp-sdks-folder)/RecoveryServices.SiteRecovery/Management.RecoveryServices.SiteRecovery/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.recoveryservicessiterecovery +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-recoveryservicessiterecovery +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-08 +``` + +### Tag: package-2016-08 and java + +These settings apply only when `--tag=package-2016-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.recoveryservicessiterecovery.v2018_01_10 + output-folder: $(azure-libraries-for-java-folder)/recoveryservicessiterecovery/resource-manager/v2018_01_10 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index f56cd48ec558..aefd0f77a9cd 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -1,227 +1,227 @@ -# Redis - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Redis. - - - ---- -## Getting Started -To build the SDK for Redis, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Redis API. - -``` yaml -openapi-type: arm -tag: package-2018-03 -``` - -### Tag: package-2018-03 - -These settings apply only when `--tag=package-2018-03` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03' -input-file: -- Microsoft.Cache/stable/2018-03-01/redis.json -``` - - -### Tag: package-2017-10 - -These settings apply only when `--tag=package-2017-10` is specified on the command line. - -``` yaml $(tag) == 'package-2017-10' -input-file: -- Microsoft.Cache/stable/2017-10-01/redis.json -``` - - -### Tag: package-2017-02 - -These settings apply only when `--tag=package-2017-02` is specified on the command line. - -``` yaml $(tag) == 'package-2017-02' -input-file: -- Microsoft.Cache/stable/2017-02-01/redis.json -``` - - -### Tag: package-2016-04 - -These settings apply only when `--tag=package-2016-04` is specified on the command line. - -``` yaml $(tag) == 'package-2016-04' -input-file: -- Microsoft.Cache/stable/2016-04-01/redis.json -``` - -### Tag: package-2015-08 - -These settings apply only when `--tag=package-2015-08` is specified on the command line. - -``` yaml $(tag) == 'package-2015-08' -input-file: -- Microsoft.Cache/stable/2015-08-01/redis.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_redis'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # last generated with AutoRest.0.17.3 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Redis - output-folder: $(csharp-sdks-folder)/RedisCache/Management.Redis/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.redis - package-name: azure-mgmt-redis - package-version: 5.0.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-redis/azure/mgmt/redis -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-redis -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.redis -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-redis -``` - -### Java multi-api -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-03 - - tag: package-2017-10 -``` - -### Tag: package-2018-03 and java - -These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.redis.v2018_03_01 - output-folder: $(azure-libraries-for-java-folder)/redis/resource-manager/v2018_03_01 -regenerate-manager: true -generate-interface: true -``` - - -### Tag: package-2017-10 and java - -These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.redis.v2017_10_01 - output-folder: $(azure-libraries-for-java-folder)/redis/resource-manager/v2017_10_01 -regenerate-manager: true -generate-interface: true -``` - - -# Validation - -## Suppression - -``` yaml -directive: - - suppress: R3006 # Model definition 'RedisResource' has extra properties ['zones']." - where: - - $.definitions.RedisResource.properties - from: redis.json - reason: zones properties will be allowed in subsequent version of the linter tool - - suppress: R3018 # Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableNonSslPort." - where: - - $.definitions.RedisCommonProperties.properties.enableNonSslPort - from: redis.json - reason: this will result in breaking change - - suppress: R2017 # PUT request and response should be of same type " - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}"].put - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}"].put - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}"].put - from: redis.json - reason: bug from sdk team - - suppress: R3010 # The child tracked resource, 'linkedServers' with immediate parent 'RedisResource', must have a list by immediate parent operation." - where: - - $.definitions - from: redis.json - reason: This is false positive, 'linkedServers' is not a tracked resource. +# Redis + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Redis. + + + +--- +## Getting Started +To build the SDK for Redis, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Redis API. + +``` yaml +openapi-type: arm +tag: package-2018-03 +``` + +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- Microsoft.Cache/stable/2018-03-01/redis.json +``` + + +### Tag: package-2017-10 + +These settings apply only when `--tag=package-2017-10` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10' +input-file: +- Microsoft.Cache/stable/2017-10-01/redis.json +``` + + +### Tag: package-2017-02 + +These settings apply only when `--tag=package-2017-02` is specified on the command line. + +``` yaml $(tag) == 'package-2017-02' +input-file: +- Microsoft.Cache/stable/2017-02-01/redis.json +``` + + +### Tag: package-2016-04 + +These settings apply only when `--tag=package-2016-04` is specified on the command line. + +``` yaml $(tag) == 'package-2016-04' +input-file: +- Microsoft.Cache/stable/2016-04-01/redis.json +``` + +### Tag: package-2015-08 + +These settings apply only when `--tag=package-2015-08` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08' +input-file: +- Microsoft.Cache/stable/2015-08-01/redis.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_redis'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # last generated with AutoRest.0.17.3 + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Redis + output-folder: $(csharp-sdks-folder)/RedisCache/Management.Redis/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.redis + package-name: azure-mgmt-redis + package-version: 5.0.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-redis/azure/mgmt/redis +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-redis +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.redis +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-redis +``` + +### Java multi-api +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-03 + - tag: package-2017-10 +``` + +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.redis.v2018_03_01 + output-folder: $(azure-libraries-for-java-folder)/redis/resource-manager/v2018_03_01 +regenerate-manager: true +generate-interface: true +``` + + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.redis.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/redis/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true +``` + + +# Validation + +## Suppression + +``` yaml +directive: + - suppress: R3006 # Model definition 'RedisResource' has extra properties ['zones']." + where: + - $.definitions.RedisResource.properties + from: redis.json + reason: zones properties will be allowed in subsequent version of the linter tool + - suppress: R3018 # Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableNonSslPort." + where: + - $.definitions.RedisCommonProperties.properties.enableNonSslPort + from: redis.json + reason: this will result in breaking change + - suppress: R2017 # PUT request and response should be of same type " + where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}/linkedServers/{linkedServerName}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{name}"].put + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/Redis/{cacheName}/firewallRules/{ruleName}"].put + from: redis.json + reason: bug from sdk team + - suppress: R3010 # The child tracked resource, 'linkedServers' with immediate parent 'RedisResource', must have a list by immediate parent operation." + where: + - $.definitions + from: redis.json + reason: This is false positive, 'linkedServers' is not a tracked resource. ``` \ No newline at end of file diff --git a/specification/relay/resource-manager/readme.md b/specification/relay/resource-manager/readme.md index 83a265cf8d45..4cdfaf0802c6 100644 --- a/specification/relay/resource-manager/readme.md +++ b/specification/relay/resource-manager/readme.md @@ -1,168 +1,168 @@ -# Relay - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Relay. - - - ---- -## Getting Started -To build the SDK for Relay, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Relay API. - -``` yaml -openapi-type: arm -tag: package-2017-04 -``` - - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.Relay/stable/2017-04-01/relay.json -``` - - -### Tag: package-2016-07 - -These settings apply only when `--tag=package-2016-07` is specified on the command line. - -``` yaml $(tag) == 'package-2016-07' -input-file: -- Microsoft.Relay/stable/2016-07-01/relay.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_relay'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Relay - output-folder: $(csharp-sdks-folder)/Relay/Management.Relay/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.relay - package-name: azure-mgmt-relay - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-relay/azure/mgmt/relay -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-relay -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.relay -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-relay -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-07 - - tag: package-2017-04 -``` - -### Tag: package-2016-07 and java - -These settings apply only when `--tag=package-2016-07 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.relay.v2016_07_01 - output-folder: $(azure-libraries-for-java-folder)/relay/resource-manager/v2016_07_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.relay.v2017_04_01 - output-folder: $(azure-libraries-for-java-folder)/relay/resource-manager/v2017_04_01 -regenerate-manager: true -generate-interface: true -``` - - +# Relay + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Relay. + + + +--- +## Getting Started +To build the SDK for Relay, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Relay API. + +``` yaml +openapi-type: arm +tag: package-2017-04 +``` + + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.Relay/stable/2017-04-01/relay.json +``` + + +### Tag: package-2016-07 + +These settings apply only when `--tag=package-2016-07` is specified on the command line. + +``` yaml $(tag) == 'package-2016-07' +input-file: +- Microsoft.Relay/stable/2016-07-01/relay.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_relay'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Relay + output-folder: $(csharp-sdks-folder)/Relay/Management.Relay/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.relay + package-name: azure-mgmt-relay + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-relay/azure/mgmt/relay +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-relay +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.relay +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-relay +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-07 + - tag: package-2017-04 +``` + +### Tag: package-2016-07 and java + +These settings apply only when `--tag=package-2016-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.relay.v2016_07_01 + output-folder: $(azure-libraries-for-java-folder)/relay/resource-manager/v2016_07_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.relay.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/relay/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/resourcehealth/resource-manager/readme.md b/specification/resourcehealth/resource-manager/readme.md index a7d6bb09fce1..df62743683db 100644 --- a/specification/resourcehealth/resource-manager/readme.md +++ b/specification/resourcehealth/resource-manager/readme.md @@ -1,121 +1,121 @@ -# ResourceHealth - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for ResourceHealth. - - - ---- -## Getting Started -To build the SDK for ResourceHealth, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the ResourceHealth API. - -``` yaml -openapi-type: arm -tag: package-2017-07 -``` - - -### Tag: package-2017-07 - -These settings apply only when `--tag=package-2017-07` is specified on the command line. - -``` yaml $(tag) == 'package-2017-07' -input-file: -- Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json -``` - - -### Tag: package-2015-01 - -These settings apply only when `--tag=package-2015-01` is specified on the command line. - -``` yaml $(tag) == 'package-2015-01' -input-file: -- Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.resourcehealth -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resourcehealth -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-07 - - tag: package-2015-01 -``` - -### Tag: package-2017-07 and java - -These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resourcehealth.v2017_07_01 - output-folder: $(azure-libraries-for-java-folder)/resourcehealth/resource-manager/v2017_07_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2015-01 and java - -These settings apply only when `--tag=package-2015-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resourcehealth.v2015_01_01 - output-folder: $(azure-libraries-for-java-folder)/resourcehealth/resource-manager/v2015_01_01 -regenerate-manager: true -generate-interface: true -``` - - +# ResourceHealth + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ResourceHealth. + + + +--- +## Getting Started +To build the SDK for ResourceHealth, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the ResourceHealth API. + +``` yaml +openapi-type: arm +tag: package-2017-07 +``` + + +### Tag: package-2017-07 + +These settings apply only when `--tag=package-2017-07` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07' +input-file: +- Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json +``` + + +### Tag: package-2015-01 + +These settings apply only when `--tag=package-2015-01` is specified on the command line. + +``` yaml $(tag) == 'package-2015-01' +input-file: +- Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.resourcehealth +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resourcehealth +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-07 + - tag: package-2015-01 +``` + +### Tag: package-2017-07 and java + +These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resourcehealth.v2017_07_01 + output-folder: $(azure-libraries-for-java-folder)/resourcehealth/resource-manager/v2017_07_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-01 and java + +These settings apply only when `--tag=package-2015-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resourcehealth.v2015_01_01 + output-folder: $(azure-libraries-for-java-folder)/resourcehealth/resource-manager/v2015_01_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 38d5c9895b71..9384eb8ca206 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -1,841 +1,841 @@ -# Resource - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Resource. - - - ---- -## Getting Started -To build the SDK for Resource, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Resource API. - -``` yaml -openapi-type: arm -``` - -``` yaml $(package-features) -tag: package-features-2015-12 -``` - -``` yaml $(package-locks) -tag: package-locks-2016-09 -``` - -``` yaml $(package-policy) -tag: package-policy-2018-05 -``` - -``` yaml $(package-resources) -tag: package-resources-2019-03 -``` - -``` yaml $(package-subscriptions) -tag: package-subscriptions-2018-06 -``` - -``` yaml $(package-links) -tag: package-links-2016-09 -``` - -``` yaml $(package-managedapplications) -tag: package-managedapplications-2016-09 -``` - -### Tag: package-features-2015-12 -These settings apply only when `--tag=package-features-2015-12` is specified on the command line. - -``` yaml $(tag) == 'package-features-2015-12' -input-file: -- Microsoft.Features/stable/2015-12-01/features.json -``` - -### Tag: package-locks-2016-09 -These settings apply only when `--tag=package-locks-2016-09` is specified on the command line. - -``` yaml $(tag) == 'package-locks-2016-09' -input-file: -- Microsoft.Authorization/stable/2016-09-01/locks.json -``` - -### Tag: package-locks-2015-01 -These settings apply only when `--tag=package-locks-2015-01` is specified on the command line. - -``` yaml $(tag) == 'package-locks-2015-01' -input-file: -- Microsoft.Authorization/stable/2015-01-01/locks.json -``` - -### Tag: package-policy-2018-05 -These settings apply only when `--tag=package-policy-2018-05` is specified on the command line. - -``` yaml $(tag) == 'package-policy-2018-05' -input-file: -- Microsoft.Authorization/stable/2018-05-01/policyAssignments.json -- Microsoft.Authorization/stable/2018-05-01/policyDefinitions.json -- Microsoft.Authorization/stable/2018-05-01/policySetDefinitions.json - -# Needed when there is more than one input file -override-info: - title: PolicyClient -``` - -### Tag: package-policy-2018-03 -These settings apply only when `--tag=package-policy-2018-03` is specified on the command line. - -``` yaml $(tag) == 'package-policy-2018-03' -input-file: -- Microsoft.Authorization/stable/2018-03-01/policyAssignments.json -- Microsoft.Authorization/stable/2018-03-01/policyDefinitions.json -- Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json - -# Needed when there is more than one input file -override-info: - title: PolicyClient -``` - -### Tag: package-policy-2017-06 -These settings apply only when `--tag=package-policy-2017-06` is specified on the command line. - -``` yaml $(tag) == 'package-policy-2017-06' -input-file: -- Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json -- Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json -- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json - -# Needed when there is more than one input file -override-info: - title: PolicyClient -``` - -### Tag: package-pure-policy-2017-06 -These settings apply only when `--tag=package-pure-policy-2017-06` is specified on the command line. - -``` yaml $(tag) == 'package-pure-policy-2017-06' -input-file: -- Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json -- Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json - -# Needed when there is more than one input file -override-info: - title: PolicyClient -``` - -### Tag: package-policy-2016-12 -These settings apply only when `--tag=package-policy-2016-12` is specified on the command line. - -``` yaml $(tag) == 'package-policy-2016-12' -input-file: -- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json -- Microsoft.Authorization/stable/2016-12-01/policyAssignments.json - -# Needed when there is more than one input file -override-info: - title: PolicyClient -``` - -### Tag: package-policy-2016-04 -These settings apply only when `--tag=package-policy-2016-04` is specified on the command line. - -``` yaml $(tag) == 'package-policy-2016-04' -input-file: -- Microsoft.Authorization/stable/2016-04-01/policy.json -``` - -### Tag: package-policy-2015-10 -These settings apply only when `--tag=package-policy-2015-10` is specified on the command line. - -``` yaml $(tag) == 'package-policy-2015-10' -input-file: -- Microsoft.Authorization/preview/2015-10-01-preview/policy.json -``` - -### Tag: package-resources-2019-03 -These settings apply only when `--tag=package-resources-2019-03` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2019-03' -input-file: -- Microsoft.Resources/stable/2019-03-01/resources.json -``` - -### Tag: package-resources-2018-05 -These settings apply only when `--tag=package-resources-2018-05` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2018-05' -input-file: -- Microsoft.Resources/stable/2018-05-01/resources.json -``` - -### Tag: package-resources-2018-02 -These settings apply only when `--tag=package-resources-2018-02` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2018-02' -input-file: -- Microsoft.Resources/stable/2018-02-01/resources.json -``` - -### Tag: package-resources-2017-05 -These settings apply only when `--tag=package-resources-2017-05` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2017-05' -input-file: -- Microsoft.Resources/stable/2017-05-10/resources.json -``` - -### Tag: package-resources-2016-09 -These settings apply only when `--tag=package-resources-2016-09` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2016-09' -input-file: -- Microsoft.Resources/stable/2016-09-01/resources.json -``` - -### Tag: package-resources-2016-07 -These settings apply only when `--tag=package-resources-2016-07` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2016-07' -input-file: -- Microsoft.Resources/stable/2016-07-01/resources.json -``` - -### Tag: package-resources-2016-02 -These settings apply only when `--tag=package-resources-2016-02` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2016-02' -input-file: -- Microsoft.Resources/stable/2016-02-01/resources.json -``` - -### Tag: package-resources-2015-11 -These settings apply only when `--tag=package-resources-2015-11` is specified on the command line. - -``` yaml $(tag) == 'package-resources-2015-11' -input-file: -- Microsoft.Resources/stable/2015-11-01/resources.json -``` - -### Tag: package-subscriptions-2018-06 -These settings apply only when `--tag=package-subscriptions-2018-06` is specified on the command line. - -``` yaml $(tag) == 'package-subscriptions-2018-06' -input-file: -- Microsoft.Resources/stable/2018-06-01/subscriptions.json -``` - -### Tag: package-subscriptions-2016-06 -These settings apply only when `--tag=package-subscriptions-2016-06` is specified on the command line. - -``` yaml $(tag) == 'package-subscriptions-2016-06' -input-file: -- Microsoft.Resources/stable/2016-06-01/subscriptions.json -``` - -### Tag: package-subscriptions-2015-11 -These settings apply only when `--tag=package-subscriptions-2015-11` is specified on the command line. - -``` yaml $(tag) == 'package-subscriptions-2015-11' -input-file: -- Microsoft.Resources/stable/2015-11-01/subscriptions.json -``` - -### Tag: package-links-2016-09 -These settings apply only when `--tag=package-links-2016-09` is specified on the command line. - -``` yaml $(tag) == 'package-links-2016-09' -input-file: -- Microsoft.Resources/stable/2016-09-01/links.json -``` - -### Tag: package-managedapplications-2018-06 -These settings apply only when `--tag=package-managedapplications-2018-06` is specified on the command line. - -``` yaml $(tag) == 'package-managedapplications-2018-06' -input-file: -- Microsoft.Solutions/stable/2018-06-01/managedapplications.json -``` - -### Tag: package-managedapplications-2017-09 -These settings apply only when `--tag=package-managedapplications-2017-09` is specified on the command line. - -``` yaml $(tag) == 'package-managedapplications-2017-09' -input-file: -- Microsoft.Solutions/stable/2017-09-01/managedapplications.json -``` - -### Tag: package-managedapplications-2016-09 -These settings apply only when `--tag=package-managedapplications-2016-09` is specified on the command line. - -``` yaml $(tag) == 'package-managedapplications-2016-09' -input-file: -- Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json -``` - -## Suppression -``` yaml -directive: - - suppress: UniqueResourcePaths - from: policySetDefinitions.json - where: $.paths - reason: policy set definition under an extension resource with Microsoft.Management - - suppress: UniqueResourcePaths - from: policyDefinitions.json - where: $.paths - reason: policy definition under an extension resource with Microsoft.Management - - suppress: OperationsAPIImplementation - from: policyAssignments.json - where: $.paths - reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger - - suppress: OperationsAPIImplementation - from: policyDefinitions.json - where: $.paths - reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger - - suppress: OperationsAPIImplementation - from: policySetDefinitions.json - where: $.paths - reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger - - suppress: BodyTopLevelProperties - from: resources.json - where: $.definitions.ResourceGroup.properties - reason: managedBy is a top level property - - suppress: BodyTopLevelProperties - from: resources.json - where: $.definitions.GenericResource.properties - reason: managedBy is a top level property - - suppress: BodyTopLevelProperties - from: resources.json - where: $.definitions.TagDetails.properties - reason: TagDetails is a top level property - - suppress: BodyTopLevelProperties - from: resources.json - where: $.definitions.TagValue.properties - reason: TagValue is a top level property - - suppress: RequiredPropertiesMissingInResourceModel - from: resources.json - where: $.definitions.TagValue - reason: TagValue will be deprecated soon - - suppress: RequiredPropertiesMissingInResourceModel - from: resources.json - where: $.definitions.TagDetails - reason: TagDetails will be deprecated soon - - suppress: XmsResourceInPutResponse - from: resources.json - where: $.paths["/subscriptions/{subscriptionId}/tagNames/{tagName}"].put - reason: TagDetails is not an Azure resource - - suppress: BodyTopLevelProperties - from: managedapplications.json - where: $.definitions.Appliance.properties - reason: managedBy is a top level property - - suppress: BodyTopLevelProperties - from: managedapplications.json - where: $.definitions.ApplianceDefinition.properties - reason: managedBy is a top level property - - suppress: BodyTopLevelProperties - from: managedapplications.json - where: $.definitions.AppliancePatchable.properties - reason: managedBy is a top level property - - suppress: BodyTopLevelProperties - from: managedapplications.json - where: $.definitions.GenericResource.properties - reason: managedBy is a top level property -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#features - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#locks - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#policy - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#resources - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#subscriptions - - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#links - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js -``` - -## Python - -These settings apply only when `--python` is specified on the command line. - -```yaml $(python) -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - package-name: azure-mgmt-resource - payload-flattening-threshold: 2 - clear-output-folder: true - no-namespace-folders: true - verbose: true - debug: true -``` - -### Python multi-api - -Generate all API versions currently shipped for this package - -```yaml $(python) && $(multiapi) -batch: - - tag: package-features-2015-12 - - tag: package-links-2016-09 - - tag: package-locks-2016-09 - - tag: package-locks-2015-01 - - tag: package-managedapplications-2018-06 - - tag: package-managedapplications-2017-09 - - tag: package-policy-2018-05 - - tag: package-policy-2018-03 - - tag: package-policy-2017-06 - - tag: package-policy-2016-12 - - tag: package-policy-2016-04 - - tag: package-policy-2015-10 - - tag: package-resources-2019-03 - - tag: package-resources-2018-05 - - tag: package-resources-2018-02 - - tag: package-resources-2017-05 - - tag: package-resources-2016-09 - - tag: package-resources-2016-02 - - tag: package-subscriptions-2018-06 - - tag: package-subscriptions-2016-06 -``` - -### Tag: package-features-2015-12 and python - -These settings apply only when `--tag=package-features-2015-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-features-2015-12' && $(python) -python: - namespace: azure.mgmt.resource.features.v2015_12_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/features/v2015_12_01 -``` - -### Tag: package-links-2016-09 and python - -These settings apply only when `--tag=package-links-2016-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-links-2016-09' && $(python) -python: - namespace: azure.mgmt.resource.links.v2016_09_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/links/v2016_09_01 -``` - -### Tag: package-locks-2016-09 and python - -These settings apply only when `--tag=package-locks-2016-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-locks-2016-09' && $(python) -python: - namespace: azure.mgmt.resource.locks.v2016_09_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/locks/v2016_09_01 -``` - -### Tag: package-locks-2015-01 and python - -These settings apply only when `--tag=package-locks-2015-01 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-locks-2015-01' && $(python) -python: - namespace: azure.mgmt.resource.locks.v2015_01_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/locks/v2015_01_01 -``` - -### Tag: package-managedapplications-2018-06 and python - -These settings apply only when `--tag=package-managedapplications-2018-06 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-managedapplications-2018-06' && $(python) -python: - namespace: azure.mgmt.resource.managedapplications - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/managedapplications -``` - -### Tag: package-managedapplications-2017-09 and python - -These settings apply only when `--tag=package-managedapplications-2017-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-managedapplications-2017-09' && $(python) -python: - namespace: azure.mgmt.resource.managedapplications - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/managedapplications -``` - -### Tag: package-policy-2018-05 and python - -These settings apply only when `--tag=package-policy-2018-05 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-policy-2018-05' && $(python) -python: - namespace: azure.mgmt.resource.policy.v2018_05_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2018_05_01 -``` - -### Tag: package-policy-2018-03 and python - -These settings apply only when `--tag=package-policy-2018-03 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-policy-2018-03' && $(python) -python: - namespace: azure.mgmt.resource.policy.v2018_03_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2018_03_01 -``` - -### Tag: package-policy-2017-06 and python - -These settings apply only when `--tag=package-policy-2017-06 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-policy-2017-06' && $(python) -python: - namespace: azure.mgmt.resource.policy.v2017_06_01_preview - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2017_06_01_preview -``` - -### Tag: package-policy-2016-12 and python - -These settings apply only when `--tag=package-policy-2016-12 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-policy-2016-12' && $(python) -python: - namespace: azure.mgmt.resource.policy.v2016_12_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2016_12_01 -``` - -### Tag: package-policy-2016-04 and python - -These settings apply only when `--tag=package-policy-2016-04 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-policy-2016-04' && $(python) -python: - namespace: azure.mgmt.resource.policy.v2016_04_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2016_04_01 -``` - -### Tag: package-policy-2015-10 and python - -These settings apply only when `--tag=package-policy-2015-10 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-policy-2015-10' && $(python) -python: - namespace: azure.mgmt.resource.policy.v2015_10_01_preview - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2015_10_01_preview -``` - -### Tag: package-resources-2019-11 and python - -These settings apply only when `--tag=package-resources-2019-11 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-resources-2019-11' && $(python) -python: - namespace: azure.mgmt.resource.resources.v2019_11_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2019_11_01 -``` - -### Tag: package-resources-2018-05 and python - -These settings apply only when `--tag=package-resources-2018-05 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-resources-2018-05' && $(python) -python: - namespace: azure.mgmt.resource.resources.v2018_05_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2018_05_01 -``` - -### Tag: package-resources-2018-02 and python - -These settings apply only when `--tag=package-resources-2018-02 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-resources-2018-02' && $(python) -python: - namespace: azure.mgmt.resource.resources.v2018_02_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2018_02_01 -``` - -### Tag: package-resources-2017-05 and python - -These settings apply only when `--tag=package-resources-2017-05 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-resources-2017-05' && $(python) -python: - namespace: azure.mgmt.resource.resources.v2017_05_10 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2017_05_10 -``` - -### Tag: package-resources-2016-09 and python - -These settings apply only when `--tag=package-resources-2016-09 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-resources-2016-09' && $(python) -python: - namespace: azure.mgmt.resource.resources.v2016_09_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2016_09_01 -``` - -### Tag: package-resources-2016-02 and python - -These settings apply only when `--tag=package-resources-2016-02 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-resources-2016-02' && $(python) -python: - namespace: azure.mgmt.resource.resources.v2016_02_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2016_02_01 -``` - -### Tag: package-subscriptions-2018-06 and python - -These settings apply only when `--tag=package-subscriptions-2018-06 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-subscriptions-2018-06' && $(python) -python: - namespace: azure.mgmt.resource.subscriptions.v2018_06_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/subscriptions/v2018_06_01 -``` - -### Tag: package-subscriptions-2016-06 and python - -These settings apply only when `--tag=package-subscriptions-2016-06 --python` is specified on the command line. -Please also specify `--python-sdks-folder=`. - -``` yaml $(tag) == 'package-subscriptions-2016-06' && $(python) -python: - namespace: azure.mgmt.resource.subscriptions.v2016_06_01 - output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/subscriptions/v2016_06_01 -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.resources -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resources -``` - -### Java multi-api - -Generate all API versions currently shipped for this package - -```yaml $(java) && $(multiapi) -batch: - - tag: package-features-2015-12 - - tag: package-locks-2016-09 - - tag: package-policy-2018-05 - - tag: package-policy-2018-03 - - tag: package-policy-2016-12 - - tag: package-resources-2019-03 - - tag: package-resources-2018-02 - - tag: package-resources-2016-09 - - tag: package-subscriptions-2018-06 - - tag: package-subscriptions-2016-06 -``` - -### Tag: package-features-2015-12 and java - -These settings apply only when `--tag=package-features-2015-12 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-features-2015-12' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.features.v2015_12_01 - output-folder: $(azure-libraries-for-java-folder)/features/resource-manager/v2015_12_01 -regenerate-manager: true -generate-interface: true -fconfig: '{"moduleName": "Features"}' -``` - -### Tag: package-locks-2016-09 and java - -These settings apply only when `--tag=package-locks-2016-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-locks-2016-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.locks.v2016_09_01 - output-folder: $(azure-libraries-for-java-folder)/locks/resource-manager/v2016_09_01 -regenerate-manager: true -generate-interface: true -fconfig: '{"moduleName": "Locks"}' -``` - -### Tag: package-policy-2018-05 and java - -These settings apply only when `--tag=package-policy-2018-05 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-policy-2018-05' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.policy.v2018_05_01 - output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2018_05_01 -regenerate-manager: true -generate-interface: true -fconfig: '{"moduleName": "Policy"}' -directive: - from: policyAssignments.json - where: $.definitions.PolicyAssignmentProperties.properties.scope - transform: $['x-ms-client-name'] = 'scopeProperty' -``` - -### Tag: package-policy-2018-03 and java - -These settings apply only when `--tag=package-policy-2018-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-policy-2018-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.policy.v2018_03_01 - output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2018_03_01 -regenerate-manager: true -generate-interface: true -fconfig: '{"moduleName": "Policy"}' -directive: - from: policyAssignments.json - where: $.definitions.PolicyAssignmentProperties.properties.scope - transform: $['x-ms-client-name'] = 'scopeProperty' -``` - -### Tag: package-policy-2016-12 and java - -These settings apply only when `--tag=package-policy-2016-12 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-policy-2016-12' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.policy.v2016_12_01 - output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2016_12_01 -regenerate-manager: true -generate-interface: true -fconfig: '{"moduleName": "Policy"}' -directive: - from: policyAssignments.json - where: $.definitions.PolicyAssignmentProperties.properties.scope - transform: $['x-ms-client-name'] = 'scopeProperty' -``` - -### Tag: package-resources-2019-03 and java - -These settings apply only when `--tag=package-resources-2019-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-resources-2019-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resources.v2019_03_01 - output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2019_03_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-resources-2018-02 and java - -These settings apply only when `--tag=package-resources-2018-02 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-resources-2018-02' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resources.v2018_02_01 - output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2018_02_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-resources-2016-09 and java - -These settings apply only when `--tag=package-resources-2016-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-resources-2016-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resources.v2016_09_01 - output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2016_09_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-subscriptions-2018-06 and java - -These settings apply only when `--tag=package-subscriptions-2018-06--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-subscriptions-2018-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resources.v2018_06_01 - output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2018_06_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-subscriptions-2016-06 and java - -These settings apply only when `--tag=package-subscriptions-2016-06--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-subscriptions-2016-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resources.v2016_06_01 - output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2016_06_01 -regenerate-manager: true -generate-interface: true -``` - -# Validation - -Since this RP has no unique default package, iterate over all of them for validation: - -``` yaml $(validation) -batch: - - package-features: true - - package-locks: true - - package-policy: true - - package-resources: true - - package-subscriptions: true - - package-links: true - - package-managedapplications: true -``` +# Resource + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Resource. + + + +--- +## Getting Started +To build the SDK for Resource, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Resource API. + +``` yaml +openapi-type: arm +``` + +``` yaml $(package-features) +tag: package-features-2015-12 +``` + +``` yaml $(package-locks) +tag: package-locks-2016-09 +``` + +``` yaml $(package-policy) +tag: package-policy-2018-05 +``` + +``` yaml $(package-resources) +tag: package-resources-2019-03 +``` + +``` yaml $(package-subscriptions) +tag: package-subscriptions-2018-06 +``` + +``` yaml $(package-links) +tag: package-links-2016-09 +``` + +``` yaml $(package-managedapplications) +tag: package-managedapplications-2016-09 +``` + +### Tag: package-features-2015-12 +These settings apply only when `--tag=package-features-2015-12` is specified on the command line. + +``` yaml $(tag) == 'package-features-2015-12' +input-file: +- Microsoft.Features/stable/2015-12-01/features.json +``` + +### Tag: package-locks-2016-09 +These settings apply only when `--tag=package-locks-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-locks-2016-09' +input-file: +- Microsoft.Authorization/stable/2016-09-01/locks.json +``` + +### Tag: package-locks-2015-01 +These settings apply only when `--tag=package-locks-2015-01` is specified on the command line. + +``` yaml $(tag) == 'package-locks-2015-01' +input-file: +- Microsoft.Authorization/stable/2015-01-01/locks.json +``` + +### Tag: package-policy-2018-05 +These settings apply only when `--tag=package-policy-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2018-05' +input-file: +- Microsoft.Authorization/stable/2018-05-01/policyAssignments.json +- Microsoft.Authorization/stable/2018-05-01/policyDefinitions.json +- Microsoft.Authorization/stable/2018-05-01/policySetDefinitions.json + +# Needed when there is more than one input file +override-info: + title: PolicyClient +``` + +### Tag: package-policy-2018-03 +These settings apply only when `--tag=package-policy-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2018-03' +input-file: +- Microsoft.Authorization/stable/2018-03-01/policyAssignments.json +- Microsoft.Authorization/stable/2018-03-01/policyDefinitions.json +- Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json + +# Needed when there is more than one input file +override-info: + title: PolicyClient +``` + +### Tag: package-policy-2017-06 +These settings apply only when `--tag=package-policy-2017-06` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2017-06' +input-file: +- Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json +- Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json +- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json + +# Needed when there is more than one input file +override-info: + title: PolicyClient +``` + +### Tag: package-pure-policy-2017-06 +These settings apply only when `--tag=package-pure-policy-2017-06` is specified on the command line. + +``` yaml $(tag) == 'package-pure-policy-2017-06' +input-file: +- Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json +- Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json + +# Needed when there is more than one input file +override-info: + title: PolicyClient +``` + +### Tag: package-policy-2016-12 +These settings apply only when `--tag=package-policy-2016-12` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2016-12' +input-file: +- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json +- Microsoft.Authorization/stable/2016-12-01/policyAssignments.json + +# Needed when there is more than one input file +override-info: + title: PolicyClient +``` + +### Tag: package-policy-2016-04 +These settings apply only when `--tag=package-policy-2016-04` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2016-04' +input-file: +- Microsoft.Authorization/stable/2016-04-01/policy.json +``` + +### Tag: package-policy-2015-10 +These settings apply only when `--tag=package-policy-2015-10` is specified on the command line. + +``` yaml $(tag) == 'package-policy-2015-10' +input-file: +- Microsoft.Authorization/preview/2015-10-01-preview/policy.json +``` + +### Tag: package-resources-2019-03 +These settings apply only when `--tag=package-resources-2019-03` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2019-03' +input-file: +- Microsoft.Resources/stable/2019-03-01/resources.json +``` + +### Tag: package-resources-2018-05 +These settings apply only when `--tag=package-resources-2018-05` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2018-05' +input-file: +- Microsoft.Resources/stable/2018-05-01/resources.json +``` + +### Tag: package-resources-2018-02 +These settings apply only when `--tag=package-resources-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2018-02' +input-file: +- Microsoft.Resources/stable/2018-02-01/resources.json +``` + +### Tag: package-resources-2017-05 +These settings apply only when `--tag=package-resources-2017-05` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2017-05' +input-file: +- Microsoft.Resources/stable/2017-05-10/resources.json +``` + +### Tag: package-resources-2016-09 +These settings apply only when `--tag=package-resources-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2016-09' +input-file: +- Microsoft.Resources/stable/2016-09-01/resources.json +``` + +### Tag: package-resources-2016-07 +These settings apply only when `--tag=package-resources-2016-07` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2016-07' +input-file: +- Microsoft.Resources/stable/2016-07-01/resources.json +``` + +### Tag: package-resources-2016-02 +These settings apply only when `--tag=package-resources-2016-02` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2016-02' +input-file: +- Microsoft.Resources/stable/2016-02-01/resources.json +``` + +### Tag: package-resources-2015-11 +These settings apply only when `--tag=package-resources-2015-11` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2015-11' +input-file: +- Microsoft.Resources/stable/2015-11-01/resources.json +``` + +### Tag: package-subscriptions-2018-06 +These settings apply only when `--tag=package-subscriptions-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-subscriptions-2018-06' +input-file: +- Microsoft.Resources/stable/2018-06-01/subscriptions.json +``` + +### Tag: package-subscriptions-2016-06 +These settings apply only when `--tag=package-subscriptions-2016-06` is specified on the command line. + +``` yaml $(tag) == 'package-subscriptions-2016-06' +input-file: +- Microsoft.Resources/stable/2016-06-01/subscriptions.json +``` + +### Tag: package-subscriptions-2015-11 +These settings apply only when `--tag=package-subscriptions-2015-11` is specified on the command line. + +``` yaml $(tag) == 'package-subscriptions-2015-11' +input-file: +- Microsoft.Resources/stable/2015-11-01/subscriptions.json +``` + +### Tag: package-links-2016-09 +These settings apply only when `--tag=package-links-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-links-2016-09' +input-file: +- Microsoft.Resources/stable/2016-09-01/links.json +``` + +### Tag: package-managedapplications-2018-06 +These settings apply only when `--tag=package-managedapplications-2018-06` is specified on the command line. + +``` yaml $(tag) == 'package-managedapplications-2018-06' +input-file: +- Microsoft.Solutions/stable/2018-06-01/managedapplications.json +``` + +### Tag: package-managedapplications-2017-09 +These settings apply only when `--tag=package-managedapplications-2017-09` is specified on the command line. + +``` yaml $(tag) == 'package-managedapplications-2017-09' +input-file: +- Microsoft.Solutions/stable/2017-09-01/managedapplications.json +``` + +### Tag: package-managedapplications-2016-09 +These settings apply only when `--tag=package-managedapplications-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-managedapplications-2016-09' +input-file: +- Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json +``` + +## Suppression +``` yaml +directive: + - suppress: UniqueResourcePaths + from: policySetDefinitions.json + where: $.paths + reason: policy set definition under an extension resource with Microsoft.Management + - suppress: UniqueResourcePaths + from: policyDefinitions.json + where: $.paths + reason: policy definition under an extension resource with Microsoft.Management + - suppress: OperationsAPIImplementation + from: policyAssignments.json + where: $.paths + reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger + - suppress: OperationsAPIImplementation + from: policyDefinitions.json + where: $.paths + reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger + - suppress: OperationsAPIImplementation + from: policySetDefinitions.json + where: $.paths + reason: operation APIs for Microsoft.Authorization are to be defined in RBAC swagger + - suppress: BodyTopLevelProperties + from: resources.json + where: $.definitions.ResourceGroup.properties + reason: managedBy is a top level property + - suppress: BodyTopLevelProperties + from: resources.json + where: $.definitions.GenericResource.properties + reason: managedBy is a top level property + - suppress: BodyTopLevelProperties + from: resources.json + where: $.definitions.TagDetails.properties + reason: TagDetails is a top level property + - suppress: BodyTopLevelProperties + from: resources.json + where: $.definitions.TagValue.properties + reason: TagValue is a top level property + - suppress: RequiredPropertiesMissingInResourceModel + from: resources.json + where: $.definitions.TagValue + reason: TagValue will be deprecated soon + - suppress: RequiredPropertiesMissingInResourceModel + from: resources.json + where: $.definitions.TagDetails + reason: TagDetails will be deprecated soon + - suppress: XmsResourceInPutResponse + from: resources.json + where: $.paths["/subscriptions/{subscriptionId}/tagNames/{tagName}"].put + reason: TagDetails is not an Azure resource + - suppress: BodyTopLevelProperties + from: managedapplications.json + where: $.definitions.Appliance.properties + reason: managedBy is a top level property + - suppress: BodyTopLevelProperties + from: managedapplications.json + where: $.definitions.ApplianceDefinition.properties + reason: managedBy is a top level property + - suppress: BodyTopLevelProperties + from: managedapplications.json + where: $.definitions.AppliancePatchable.properties + reason: managedBy is a top level property + - suppress: BodyTopLevelProperties + from: managedapplications.json + where: $.definitions.GenericResource.properties + reason: managedBy is a top level property +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#features + - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#locks + - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#policy + - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#resources + - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#subscriptions + - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#links + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js +``` + +## Python + +These settings apply only when `--python` is specified on the command line. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + package-name: azure-mgmt-resource + payload-flattening-threshold: 2 + clear-output-folder: true + no-namespace-folders: true + verbose: true + debug: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(python) && $(multiapi) +batch: + - tag: package-features-2015-12 + - tag: package-links-2016-09 + - tag: package-locks-2016-09 + - tag: package-locks-2015-01 + - tag: package-managedapplications-2018-06 + - tag: package-managedapplications-2017-09 + - tag: package-policy-2018-05 + - tag: package-policy-2018-03 + - tag: package-policy-2017-06 + - tag: package-policy-2016-12 + - tag: package-policy-2016-04 + - tag: package-policy-2015-10 + - tag: package-resources-2019-03 + - tag: package-resources-2018-05 + - tag: package-resources-2018-02 + - tag: package-resources-2017-05 + - tag: package-resources-2016-09 + - tag: package-resources-2016-02 + - tag: package-subscriptions-2018-06 + - tag: package-subscriptions-2016-06 +``` + +### Tag: package-features-2015-12 and python + +These settings apply only when `--tag=package-features-2015-12 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-features-2015-12' && $(python) +python: + namespace: azure.mgmt.resource.features.v2015_12_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/features/v2015_12_01 +``` + +### Tag: package-links-2016-09 and python + +These settings apply only when `--tag=package-links-2016-09 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-links-2016-09' && $(python) +python: + namespace: azure.mgmt.resource.links.v2016_09_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/links/v2016_09_01 +``` + +### Tag: package-locks-2016-09 and python + +These settings apply only when `--tag=package-locks-2016-09 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-locks-2016-09' && $(python) +python: + namespace: azure.mgmt.resource.locks.v2016_09_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/locks/v2016_09_01 +``` + +### Tag: package-locks-2015-01 and python + +These settings apply only when `--tag=package-locks-2015-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-locks-2015-01' && $(python) +python: + namespace: azure.mgmt.resource.locks.v2015_01_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/locks/v2015_01_01 +``` + +### Tag: package-managedapplications-2018-06 and python + +These settings apply only when `--tag=package-managedapplications-2018-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2018-06' && $(python) +python: + namespace: azure.mgmt.resource.managedapplications + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/managedapplications +``` + +### Tag: package-managedapplications-2017-09 and python + +These settings apply only when `--tag=package-managedapplications-2017-09 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-managedapplications-2017-09' && $(python) +python: + namespace: azure.mgmt.resource.managedapplications + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/managedapplications +``` + +### Tag: package-policy-2018-05 and python + +These settings apply only when `--tag=package-policy-2018-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2018-05' && $(python) +python: + namespace: azure.mgmt.resource.policy.v2018_05_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2018_05_01 +``` + +### Tag: package-policy-2018-03 and python + +These settings apply only when `--tag=package-policy-2018-03 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2018-03' && $(python) +python: + namespace: azure.mgmt.resource.policy.v2018_03_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2018_03_01 +``` + +### Tag: package-policy-2017-06 and python + +These settings apply only when `--tag=package-policy-2017-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2017-06' && $(python) +python: + namespace: azure.mgmt.resource.policy.v2017_06_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2017_06_01_preview +``` + +### Tag: package-policy-2016-12 and python + +These settings apply only when `--tag=package-policy-2016-12 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2016-12' && $(python) +python: + namespace: azure.mgmt.resource.policy.v2016_12_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2016_12_01 +``` + +### Tag: package-policy-2016-04 and python + +These settings apply only when `--tag=package-policy-2016-04 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2016-04' && $(python) +python: + namespace: azure.mgmt.resource.policy.v2016_04_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2016_04_01 +``` + +### Tag: package-policy-2015-10 and python + +These settings apply only when `--tag=package-policy-2015-10 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-policy-2015-10' && $(python) +python: + namespace: azure.mgmt.resource.policy.v2015_10_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/policy/v2015_10_01_preview +``` + +### Tag: package-resources-2019-11 and python + +These settings apply only when `--tag=package-resources-2019-11 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2019-11' && $(python) +python: + namespace: azure.mgmt.resource.resources.v2019_11_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2019_11_01 +``` + +### Tag: package-resources-2018-05 and python + +These settings apply only when `--tag=package-resources-2018-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2018-05' && $(python) +python: + namespace: azure.mgmt.resource.resources.v2018_05_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2018_05_01 +``` + +### Tag: package-resources-2018-02 and python + +These settings apply only when `--tag=package-resources-2018-02 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2018-02' && $(python) +python: + namespace: azure.mgmt.resource.resources.v2018_02_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2018_02_01 +``` + +### Tag: package-resources-2017-05 and python + +These settings apply only when `--tag=package-resources-2017-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2017-05' && $(python) +python: + namespace: azure.mgmt.resource.resources.v2017_05_10 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2017_05_10 +``` + +### Tag: package-resources-2016-09 and python + +These settings apply only when `--tag=package-resources-2016-09 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2016-09' && $(python) +python: + namespace: azure.mgmt.resource.resources.v2016_09_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2016_09_01 +``` + +### Tag: package-resources-2016-02 and python + +These settings apply only when `--tag=package-resources-2016-02 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2016-02' && $(python) +python: + namespace: azure.mgmt.resource.resources.v2016_02_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/resources/v2016_02_01 +``` + +### Tag: package-subscriptions-2018-06 and python + +These settings apply only when `--tag=package-subscriptions-2018-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-subscriptions-2018-06' && $(python) +python: + namespace: azure.mgmt.resource.subscriptions.v2018_06_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/subscriptions/v2018_06_01 +``` + +### Tag: package-subscriptions-2016-06 and python + +These settings apply only when `--tag=package-subscriptions-2016-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-subscriptions-2016-06' && $(python) +python: + namespace: azure.mgmt.resource.subscriptions.v2016_06_01 + output-folder: $(python-sdks-folder)/azure-mgmt-resource/azure/mgmt/resource/subscriptions/v2016_06_01 +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.resources +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-resources +``` + +### Java multi-api + +Generate all API versions currently shipped for this package + +```yaml $(java) && $(multiapi) +batch: + - tag: package-features-2015-12 + - tag: package-locks-2016-09 + - tag: package-policy-2018-05 + - tag: package-policy-2018-03 + - tag: package-policy-2016-12 + - tag: package-resources-2019-03 + - tag: package-resources-2018-02 + - tag: package-resources-2016-09 + - tag: package-subscriptions-2018-06 + - tag: package-subscriptions-2016-06 +``` + +### Tag: package-features-2015-12 and java + +These settings apply only when `--tag=package-features-2015-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-features-2015-12' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.features.v2015_12_01 + output-folder: $(azure-libraries-for-java-folder)/features/resource-manager/v2015_12_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Features"}' +``` + +### Tag: package-locks-2016-09 and java + +These settings apply only when `--tag=package-locks-2016-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-locks-2016-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.locks.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/locks/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Locks"}' +``` + +### Tag: package-policy-2018-05 and java + +These settings apply only when `--tag=package-policy-2018-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-policy-2018-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.policy.v2018_05_01 + output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2018_05_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Policy"}' +directive: + from: policyAssignments.json + where: $.definitions.PolicyAssignmentProperties.properties.scope + transform: $['x-ms-client-name'] = 'scopeProperty' +``` + +### Tag: package-policy-2018-03 and java + +These settings apply only when `--tag=package-policy-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-policy-2018-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.policy.v2018_03_01 + output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2018_03_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Policy"}' +directive: + from: policyAssignments.json + where: $.definitions.PolicyAssignmentProperties.properties.scope + transform: $['x-ms-client-name'] = 'scopeProperty' +``` + +### Tag: package-policy-2016-12 and java + +These settings apply only when `--tag=package-policy-2016-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-policy-2016-12' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.policy.v2016_12_01 + output-folder: $(azure-libraries-for-java-folder)/policy/resource-manager/v2016_12_01 +regenerate-manager: true +generate-interface: true +fconfig: '{"moduleName": "Policy"}' +directive: + from: policyAssignments.json + where: $.definitions.PolicyAssignmentProperties.properties.scope + transform: $['x-ms-client-name'] = 'scopeProperty' +``` + +### Tag: package-resources-2019-03 and java + +These settings apply only when `--tag=package-resources-2019-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-resources-2019-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resources.v2019_03_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2019_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-resources-2018-02 and java + +These settings apply only when `--tag=package-resources-2018-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-resources-2018-02' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resources.v2018_02_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2018_02_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-resources-2016-09 and java + +These settings apply only when `--tag=package-resources-2016-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-resources-2016-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resources.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-subscriptions-2018-06 and java + +These settings apply only when `--tag=package-subscriptions-2018-06--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-subscriptions-2018-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resources.v2018_06_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2018_06_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-subscriptions-2016-06 and java + +These settings apply only when `--tag=package-subscriptions-2016-06--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-subscriptions-2016-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resources.v2016_06_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2016_06_01 +regenerate-manager: true +generate-interface: true +``` + +# Validation + +Since this RP has no unique default package, iterate over all of them for validation: + +``` yaml $(validation) +batch: + - package-features: true + - package-locks: true + - package-policy: true + - package-resources: true + - package-subscriptions: true + - package-links: true + - package-managedapplications: true +``` diff --git a/specification/scheduler/resource-manager/readme.md b/specification/scheduler/resource-manager/readme.md index 5402fc586d48..d6f3141572e6 100644 --- a/specification/scheduler/resource-manager/readme.md +++ b/specification/scheduler/resource-manager/readme.md @@ -1,188 +1,188 @@ -# Scheduler - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Scheduler. - - - ---- -## Getting Started -To build the SDK for Scheduler, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Scheduler API. - -``` yaml -openapi-type: arm -tag: package-2016-03 -``` - - -### Tag: package-2016-03 - -These settings apply only when `--tag=package-2016-03` is specified on the command line. - -``` yaml $(tag) == 'package-2016-03' -input-file: -- Microsoft.Scheduler/stable/2016-03-01/scheduler.json -``` - -### Tag: package-2016-01 - -These settings apply only when `--tag=package-2016-01` is specified on the command line. - -``` yaml $(tag) == 'package-2016-01' -input-file: -- Microsoft.Scheduler/stable/2016-01-01/scheduler.json -``` - -### Tag: package-2014-08-preview - -These settings apply only when `--tag=package-2014-08-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2014-08-preview' -input-file: -- Microsoft.Scheduler/preview/2014-08-01-preview/scheduler.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_scheduler'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: NONE - namespace: Microsoft.Azure.Management.Scheduler - output-folder: $(csharp-sdks-folder)/Scheduler/Management.Scheduler/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.scheduler - package-name: azure-mgmt-scheduler - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-scheduler/azure/mgmt/scheduler -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-scheduler -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.scheduler -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-scheduler -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2014-08-preview - - tag: package-2016-01 - - tag: package-2016-03 -``` - -### Tag: package-2014-08-preview and java - -These settings apply only when `--tag=package-2014-08-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2014-08-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.scheduler.v2014_08_01_preview - output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2014_08_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-01 and java - -These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.scheduler.v2016_01_01 - output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2016_01_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-03 and java - -These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.scheduler.v2016_03_01 - output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2016_03_01 -regenerate-manager: true -generate-interface: true -``` - - +# Scheduler + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Scheduler. + + + +--- +## Getting Started +To build the SDK for Scheduler, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Scheduler API. + +``` yaml +openapi-type: arm +tag: package-2016-03 +``` + + +### Tag: package-2016-03 + +These settings apply only when `--tag=package-2016-03` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03' +input-file: +- Microsoft.Scheduler/stable/2016-03-01/scheduler.json +``` + +### Tag: package-2016-01 + +These settings apply only when `--tag=package-2016-01` is specified on the command line. + +``` yaml $(tag) == 'package-2016-01' +input-file: +- Microsoft.Scheduler/stable/2016-01-01/scheduler.json +``` + +### Tag: package-2014-08-preview + +These settings apply only when `--tag=package-2014-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2014-08-preview' +input-file: +- Microsoft.Scheduler/preview/2014-08-01-preview/scheduler.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_scheduler'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: NONE + namespace: Microsoft.Azure.Management.Scheduler + output-folder: $(csharp-sdks-folder)/Scheduler/Management.Scheduler/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.scheduler + package-name: azure-mgmt-scheduler + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-scheduler/azure/mgmt/scheduler +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-scheduler +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.scheduler +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-scheduler +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2014-08-preview + - tag: package-2016-01 + - tag: package-2016-03 +``` + +### Tag: package-2014-08-preview and java + +These settings apply only when `--tag=package-2014-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2014-08-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.scheduler.v2014_08_01_preview + output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2014_08_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-01 and java + +These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.scheduler.v2016_01_01 + output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2016_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-03 and java + +These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.scheduler.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/scheduler/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/search/resource-manager/readme.md b/specification/search/resource-manager/readme.md index 22eb453fea8d..d31bc5f1f1fb 100644 --- a/specification/search/resource-manager/readme.md +++ b/specification/search/resource-manager/readme.md @@ -1,167 +1,167 @@ -# SearchManagementClient - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for SearchManagementClient. - - - ---- -## Getting Started -To build the SDK for SearchManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the SearchManagementClient API. - -``` yaml -openapi-type: arm -tag: package-2015-08 -``` - - -### Tag: package-2015-08 - -These settings apply only when `--tag=package-2015-08` is specified on the command line. - -``` yaml $(tag) == 'package-2015-08' -input-file: -- Microsoft.Search/stable/2015-08-19/search.json -``` - -### Tag: package-2015-02 - -These settings apply only when `--tag=package-2015-02` is specified on the command line. - -``` yaml $(tag) == 'package-2015-02' -input-file: -- Microsoft.Search/stable/2015-02-28/search.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_search'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Search - output-folder: $(csharp-sdks-folder)/Search/Management/Management.Search/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.search - package-name: azure-mgmt-search - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-search/azure/mgmt/search -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-search -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.search -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-search -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-02 - - tag: package-2015-08 -``` - -### Tag: package-2015-02 and java - -These settings apply only when `--tag=package-2015-02 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-02' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.searchmanagementclient.v2015_02_28 - output-folder: $(azure-libraries-for-java-folder)/searchmanagementclient/resource-manager/v2015_02_28 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2015-08 and java - -These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.searchmanagementclient.v2015_08_19 - output-folder: $(azure-libraries-for-java-folder)/searchmanagementclient/resource-manager/v2015_08_19 -regenerate-manager: true -generate-interface: true -``` - - +# SearchManagementClient + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for SearchManagementClient. + + + +--- +## Getting Started +To build the SDK for SearchManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the SearchManagementClient API. + +``` yaml +openapi-type: arm +tag: package-2015-08 +``` + + +### Tag: package-2015-08 + +These settings apply only when `--tag=package-2015-08` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08' +input-file: +- Microsoft.Search/stable/2015-08-19/search.json +``` + +### Tag: package-2015-02 + +These settings apply only when `--tag=package-2015-02` is specified on the command line. + +``` yaml $(tag) == 'package-2015-02' +input-file: +- Microsoft.Search/stable/2015-02-28/search.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_search'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Search + output-folder: $(csharp-sdks-folder)/Search/Management/Management.Search/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.search + package-name: azure-mgmt-search + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-search/azure/mgmt/search +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-search +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.search +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-search +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-02 + - tag: package-2015-08 +``` + +### Tag: package-2015-02 and java + +These settings apply only when `--tag=package-2015-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-02' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.searchmanagementclient.v2015_02_28 + output-folder: $(azure-libraries-for-java-folder)/searchmanagementclient/resource-manager/v2015_02_28 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2015-08 and java + +These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.searchmanagementclient.v2015_08_19 + output-folder: $(azure-libraries-for-java-folder)/searchmanagementclient/resource-manager/v2015_08_19 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json index 1041325bfbcd..8e8296514853 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json @@ -1,412 +1,412 @@ -{ - "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": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings": { - "get": { - "x-ms-examples": { - "List Adaptive Network Hardenings resources of an extended resource": { - "$ref": "./examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json" - } - }, - "description": "Gets a list of Adaptive Network Hardenings resources in scope of an extended resource.", - "tags": [ - "AdaptiveNetworkHardenings" - ], - "operationId": "AdaptiveNetworkHardenings_ListByExtendedResource", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardeningsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}": { - "get": { - "x-ms-examples": { - "Get a single Adaptive Network Hardening resource": { - "$ref": "./examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json" - } - }, - "tags": [ - "AdaptiveNetworkHardenings" - ], - "description": "Gets a single Adaptive Network Hardening resource", - "operationId": "AdaptiveNetworkHardenings_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardening" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}/{adaptiveNetworkHardeningEnforceAction}": { - "post": { - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Enforces the given rules on the NSG(s) listed in the request": { - "$ref": "./examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json" - } - }, - "tags": [ - "AdaptiveNetworkHardenings" - ], - "description": "Enforces the given rules on the NSG(s) listed in the request", - "operationId": "AdaptiveNetworkHardenings_Enforce", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "name": "resourceNamespace", - "in": "path", - "description": "The Namespace of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "The type of the resource.", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Name of the resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceAction" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceRequest" - } - ], - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "PortNumber": { - "type": "integer", - "minimum": 0, - "maximum": 65535 - }, - "Rule": { - "description": "Describes remote addresses that is recommended to communicate with the Azure resource on some (Protocol, Port, Direction). All other remote addresses are recommended to be blocked", - "properties": { - "name": { - "description": "The name of the rule", - "type": "string" - }, - "direction": { - "description": "The rule's direction", - "type": "string", - "enum": [ - "Inbound", - "Outbound" - ], - "x-ms-enum": { - "name": "direction", - "modelAsString": true - } - }, - "destinationPort": { - "description": "The rule's destination port", - "$ref": "#/definitions/PortNumber" - }, - "protocols": { - "description": "The rule's transport protocols", - "type": "array", - "items": { - "type": "string", - "enum": [ - "TCP", - "UDP" - ], - "x-ms-enum": { - "name": "transportProtocol", - "modelAsString": true - } - } - }, - "ipAddresses": { - "description": "The remote IP addresses that should be able to communicate with the Azure resource on the rule's destination port and protocol", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "EffectiveNetworkSecurityGroups": { - "description": "Describes the Network Security Groups effective on a network interface", - "properties": { - "networkInterface": { - "description": "The Azure resource ID of the network interface", - "type": "string" - }, - "networkSecurityGroups": { - "description": "The Network Security Groups effective on the network interface", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "AdaptiveNetworkHardeningProperties": { - "description": "Adaptive Network Hardening resource properties", - "properties": { - "rules": { - "description": "The security rules which are recommended to be effective on the VM", - "type": "array", - "items": { - "$ref": "#/definitions/Rule" - } - }, - "rulesCalculationTime": { - "type": "string", - "format": "date-time", - "description": "The UTC time on which the rules were calculated" - }, - "effectiveNetworkSecurityGroups": { - "description": "The Network Security Groups effective on the network interfaces of the protected resource", - "type": "array", - "items": { - "$ref": "#/definitions/EffectiveNetworkSecurityGroups" - } - } - } - }, - "AdaptiveNetworkHardening": { - "description": "The resource whose properties describes the Adaptive Network Hardening settings for some Azure resource", - "properties": { - "properties": { - "description": "Properties of the Adaptive Network Hardening resource", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AdaptiveNetworkHardeningProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "AdaptiveNetworkHardeningsList": { - "description": "Response for ListAdaptiveNetworkHardenings API service call", - "properties": { - "value": { - "description": "A list of Adaptive Network Hardenings resources", - "type": "array", - "items": { - "$ref": "#/definitions/AdaptiveNetworkHardening" - } - }, - "nextLink": { - "description": "The URL to get the next set of results", - "type": "string" - } - } - }, - "AdaptiveNetworkHardeningEnforceRequest": { - "type": "object", - "properties": { - "rules": { - "type": "array", - "description": "The rules to enforce", - "items": { - "$ref": "#/definitions/Rule" - } - }, - "networkSecurityGroups": { - "type": "array", - "description": "The Azure resource IDs of the effective network security groups that will be updated with the created security rules from the Adaptive Network Hardening rules", - "items": { - "type": "string" - } - } - }, - "required": [ - "rules", - "networkSecurityGroups" - ] - } - }, - "parameters": { - "AdaptiveNetworkHardeningResourceName": { - "name": "adaptiveNetworkHardeningResourceName", - "in": "path", - "description": "The name of the Adaptive Network Hardening resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "AdaptiveNetworkHardeningEnforceAction": { - "name": "adaptiveNetworkHardeningEnforceAction", - "type": "string", - "in": "path", - "required": true, - "description": "Enforces the given rules on the NSG(s) listed in the request", - "enum": [ - "enforce" - ], - "x-ms-parameter-location": "method" - }, - "AdaptiveNetworkHardeningEnforceRequest": { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AdaptiveNetworkHardeningEnforceRequest" - }, - "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": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings": { + "get": { + "x-ms-examples": { + "List Adaptive Network Hardenings resources of an extended resource": { + "$ref": "./examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json" + } + }, + "description": "Gets a list of Adaptive Network Hardenings resources in scope of an extended resource.", + "tags": [ + "AdaptiveNetworkHardenings" + ], + "operationId": "AdaptiveNetworkHardenings_ListByExtendedResource", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "name": "resourceNamespace", + "in": "path", + "description": "The Namespace of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "The type of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdaptiveNetworkHardeningsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}": { + "get": { + "x-ms-examples": { + "Get a single Adaptive Network Hardening resource": { + "$ref": "./examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json" + } + }, + "tags": [ + "AdaptiveNetworkHardenings" + ], + "description": "Gets a single Adaptive Network Hardening resource", + "operationId": "AdaptiveNetworkHardenings_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "name": "resourceNamespace", + "in": "path", + "description": "The Namespace of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "The type of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdaptiveNetworkHardening" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.Security/adaptiveNetworkHardenings/{adaptiveNetworkHardeningResourceName}/{adaptiveNetworkHardeningEnforceAction}": { + "post": { + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Enforces the given rules on the NSG(s) listed in the request": { + "$ref": "./examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json" + } + }, + "tags": [ + "AdaptiveNetworkHardenings" + ], + "description": "Enforces the given rules on the NSG(s) listed in the request", + "operationId": "AdaptiveNetworkHardenings_Enforce", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "name": "resourceNamespace", + "in": "path", + "description": "The Namespace of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "The type of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/AdaptiveNetworkHardeningResourceName" + }, + { + "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceAction" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AdaptiveNetworkHardeningEnforceRequest" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "PortNumber": { + "type": "integer", + "minimum": 0, + "maximum": 65535 + }, + "Rule": { + "description": "Describes remote addresses that is recommended to communicate with the Azure resource on some (Protocol, Port, Direction). All other remote addresses are recommended to be blocked", + "properties": { + "name": { + "description": "The name of the rule", + "type": "string" + }, + "direction": { + "description": "The rule's direction", + "type": "string", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "destinationPort": { + "description": "The rule's destination port", + "$ref": "#/definitions/PortNumber" + }, + "protocols": { + "description": "The rule's transport protocols", + "type": "array", + "items": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "transportProtocol", + "modelAsString": true + } + } + }, + "ipAddresses": { + "description": "The remote IP addresses that should be able to communicate with the Azure resource on the rule's destination port and protocol", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EffectiveNetworkSecurityGroups": { + "description": "Describes the Network Security Groups effective on a network interface", + "properties": { + "networkInterface": { + "description": "The Azure resource ID of the network interface", + "type": "string" + }, + "networkSecurityGroups": { + "description": "The Network Security Groups effective on the network interface", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AdaptiveNetworkHardeningProperties": { + "description": "Adaptive Network Hardening resource properties", + "properties": { + "rules": { + "description": "The security rules which are recommended to be effective on the VM", + "type": "array", + "items": { + "$ref": "#/definitions/Rule" + } + }, + "rulesCalculationTime": { + "type": "string", + "format": "date-time", + "description": "The UTC time on which the rules were calculated" + }, + "effectiveNetworkSecurityGroups": { + "description": "The Network Security Groups effective on the network interfaces of the protected resource", + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroups" + } + } + } + }, + "AdaptiveNetworkHardening": { + "description": "The resource whose properties describes the Adaptive Network Hardening settings for some Azure resource", + "properties": { + "properties": { + "description": "Properties of the Adaptive Network Hardening resource", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AdaptiveNetworkHardeningProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "AdaptiveNetworkHardeningsList": { + "description": "Response for ListAdaptiveNetworkHardenings API service call", + "properties": { + "value": { + "description": "A list of Adaptive Network Hardenings resources", + "type": "array", + "items": { + "$ref": "#/definitions/AdaptiveNetworkHardening" + } + }, + "nextLink": { + "description": "The URL to get the next set of results", + "type": "string" + } + } + }, + "AdaptiveNetworkHardeningEnforceRequest": { + "type": "object", + "properties": { + "rules": { + "type": "array", + "description": "The rules to enforce", + "items": { + "$ref": "#/definitions/Rule" + } + }, + "networkSecurityGroups": { + "type": "array", + "description": "The Azure resource IDs of the effective network security groups that will be updated with the created security rules from the Adaptive Network Hardening rules", + "items": { + "type": "string" + } + } + }, + "required": [ + "rules", + "networkSecurityGroups" + ] + } + }, + "parameters": { + "AdaptiveNetworkHardeningResourceName": { + "name": "adaptiveNetworkHardeningResourceName", + "in": "path", + "description": "The name of the Adaptive Network Hardening resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AdaptiveNetworkHardeningEnforceAction": { + "name": "adaptiveNetworkHardeningEnforceAction", + "type": "string", + "in": "path", + "required": true, + "description": "Enforces the given rules on the NSG(s) listed in the request", + "enum": [ + "enforce" + ], + "x-ms-parameter-location": "method" + }, + "AdaptiveNetworkHardeningEnforceRequest": { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AdaptiveNetworkHardeningEnforceRequest" + }, + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/alerts.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/alerts.json index 7f52f7dd7f0f..653493529a89 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/alerts.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/alerts.json @@ -1,625 +1,625 @@ -{ - "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": { - "/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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 that are associated with the resource group", - "operationId": "Alerts_ListByResourceGroup", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AlertList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Alert" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Alert" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - }, - { - "$ref": "#/parameters/AlertUpdateActionType" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/AlertName" - }, - { - "$ref": "#/parameters/AlertUpdateActionType" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/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", - "enum": ["Silent", "Information", "Low", "High"], - "x-ms-enum": { - "name": "reportedSeverity", - "modelAsString": true, - "values": [ - { - "value": "Silent" - }, - { - "value": "Information" - }, - { - "value": "Low" - }, - { - "value": "High" - } - ] - }, - "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" - }, - "isIncident": { - "readOnly": true, - "type": "boolean", - "description": "Whether this alert is for incident type or not (otherwise - single alert)" - }, - "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." - }, - "correlationKey": { - "readOnly": true, - "type": "string", - "description": "Alerts with the same CorrelationKey will be grouped together in Ibiza." - } - } - }, - "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": true, - "description": "Changing set of properties depending on the entity type.", - "properties": { - "type": { - "readOnly": true, - "type": "string", - "description": "Type of entity" - } - } - }, - "AlertExtendedProperties": { - "type": "object", - "additionalProperties": true, - "description": "Changing set of properties depending on the alert type." - } - }, - "parameters": { - "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" - } - } -} +{ + "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": { + "/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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 that are associated with the resource group", + "operationId": "Alerts_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataSelect" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataExpand" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/AlertUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/AlertName" + }, + { + "$ref": "#/parameters/AlertUpdateActionType" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/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", + "enum": ["Silent", "Information", "Low", "High"], + "x-ms-enum": { + "name": "reportedSeverity", + "modelAsString": true, + "values": [ + { + "value": "Silent" + }, + { + "value": "Information" + }, + { + "value": "Low" + }, + { + "value": "High" + } + ] + }, + "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" + }, + "isIncident": { + "readOnly": true, + "type": "boolean", + "description": "Whether this alert is for incident type or not (otherwise - single alert)" + }, + "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." + }, + "correlationKey": { + "readOnly": true, + "type": "string", + "description": "Alerts with the same CorrelationKey will be grouped together in Ibiza." + } + } + }, + "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": true, + "description": "Changing set of properties depending on the entity type.", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "Type of entity" + } + } + }, + "AlertExtendedProperties": { + "type": "object", + "additionalProperties": true, + "description": "Changing set of properties depending on the alert type." + } + }, + "parameters": { + "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" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json index 108573e2e5dc..f01b8f50cf6a 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json @@ -1,280 +1,280 @@ -{ - "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": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/allowedConnections": { - "get": { - "x-ms-examples": { - "Get allowed connections on a subscription": { - "$ref": "./examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json" - } - }, - "tags": ["AllowedConnections"], - "description": "Gets the list of all possible traffic between resources for the subscription", - "operationId": "AllowedConnections_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AllowedConnectionsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections": { - "get": { - "x-ms-examples": { - "Get allowed connections on a subscription from security data location": { - "$ref": "./examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json" - } - }, - "tags": ["AllowedConnections"], - "description": "Gets the list of all possible traffic between resources for the subscription and location.", - "operationId": "AllowedConnections_ListByHomeRegion", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AllowedConnectionsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections/{connectionType}": { - "get": { - "x-ms-examples": { - "Get allowed connections": { - "$ref": "./examples/AllowedConnections/GetAllowedConnections_example.json" - } - }, - "tags": ["AllowedConnections"], - "description": "Gets the list of all possible traffic between resources for the subscription and location, based on connection type.", - "operationId": "AllowedConnections_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ConnectionType" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AllowedConnectionsResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "AllowedConnectionsList": { - "type": "object", - "description": "List of all possible traffic between Azure resources", - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/AllowedConnectionsResource" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "AllowedConnectionsResource": { - "type": "object", - "description": "The resource whose properties describes the allowed traffic between Azure resources", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "readOnly": true, - "$ref": "#/definitions/AllowedConnectionsResourceProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - }, - { - "$ref": "../../../common/v1/types.json#/definitions/Location" - } - ] - }, - "AllowedConnectionsResourceProperties": { - "type": "object", - "description": "Describes the allowed traffic between Azure resources", - "properties": { - "calculatedDateTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The UTC time on which the allowed connections resource was calculated" - }, - "connectableResources": { - "type": "array", - "readOnly": true, - "description": "List of connectable resources", - "items": { - "$ref": "#/definitions/ConnectableResource" - } - } - } - }, - "ConnectableResource": { - "type": "object", - "description": "Describes the allowed inbound and outbound traffic of an Azure resource", - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The Azure resource id" - }, - "inboundConnectedResources": { - "type": "array", - "readOnly": true, - "description": "The list of Azure resources that the resource has inbound allowed connection from", - "items": { - "$ref": "#/definitions/ConnectedResource" - } - }, - "outboundConnectedResources": { - "type": "array", - "readOnly": true, - "description": "The list of Azure resources that the resource has outbound allowed connection to", - "items": { - "$ref": "#/definitions/ConnectedResource" - } - } - } - }, - "ConnectedResource": { - "type": "object", - "description": "Describes properties of a connected resource", - "properties": { - "connectedResourceId": { - "type": "string", - "readOnly": true, - "description": "The Azure resource id of the connected resource" - }, - "tcpPorts": { - "type": "string", - "readOnly": true, - "description": "The allowed tcp ports" - }, - "udpPorts": { - "type": "string", - "readOnly": true, - "description": "The allowed udp ports" - } - } - } - }, - "parameters": { - "ConnectionType": { - "name": "connectionType", - "type": "string", - "in": "path", - "description": "The type of allowed connections (Internal, External)", - "required": true, - "enum": ["Internal", "External"], - "x-ms-enum": { - "name": "connectionType", - "modelAsString": true, - "values": [ - { - "value": "Internal" - }, - { - "value": "External" - } - ] - }, - "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": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/allowedConnections": { + "get": { + "x-ms-examples": { + "Get allowed connections on a subscription": { + "$ref": "./examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json" + } + }, + "tags": ["AllowedConnections"], + "description": "Gets the list of all possible traffic between resources for the subscription", + "operationId": "AllowedConnections_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AllowedConnectionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections": { + "get": { + "x-ms-examples": { + "Get allowed connections on a subscription from security data location": { + "$ref": "./examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json" + } + }, + "tags": ["AllowedConnections"], + "description": "Gets the list of all possible traffic between resources for the subscription and location.", + "operationId": "AllowedConnections_ListByHomeRegion", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AllowedConnectionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections/{connectionType}": { + "get": { + "x-ms-examples": { + "Get allowed connections": { + "$ref": "./examples/AllowedConnections/GetAllowedConnections_example.json" + } + }, + "tags": ["AllowedConnections"], + "description": "Gets the list of all possible traffic between resources for the subscription and location, based on connection type.", + "operationId": "AllowedConnections_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ConnectionType" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AllowedConnectionsResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AllowedConnectionsList": { + "type": "object", + "description": "List of all possible traffic between Azure resources", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AllowedConnectionsResource" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "AllowedConnectionsResource": { + "type": "object", + "description": "The resource whose properties describes the allowed traffic between Azure resources", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/AllowedConnectionsResourceProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "../../../common/v1/types.json#/definitions/Location" + } + ] + }, + "AllowedConnectionsResourceProperties": { + "type": "object", + "description": "Describes the allowed traffic between Azure resources", + "properties": { + "calculatedDateTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The UTC time on which the allowed connections resource was calculated" + }, + "connectableResources": { + "type": "array", + "readOnly": true, + "description": "List of connectable resources", + "items": { + "$ref": "#/definitions/ConnectableResource" + } + } + } + }, + "ConnectableResource": { + "type": "object", + "description": "Describes the allowed inbound and outbound traffic of an Azure resource", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The Azure resource id" + }, + "inboundConnectedResources": { + "type": "array", + "readOnly": true, + "description": "The list of Azure resources that the resource has inbound allowed connection from", + "items": { + "$ref": "#/definitions/ConnectedResource" + } + }, + "outboundConnectedResources": { + "type": "array", + "readOnly": true, + "description": "The list of Azure resources that the resource has outbound allowed connection to", + "items": { + "$ref": "#/definitions/ConnectedResource" + } + } + } + }, + "ConnectedResource": { + "type": "object", + "description": "Describes properties of a connected resource", + "properties": { + "connectedResourceId": { + "type": "string", + "readOnly": true, + "description": "The Azure resource id of the connected resource" + }, + "tcpPorts": { + "type": "string", + "readOnly": true, + "description": "The allowed tcp ports" + }, + "udpPorts": { + "type": "string", + "readOnly": true, + "description": "The allowed udp ports" + } + } + } + }, + "parameters": { + "ConnectionType": { + "name": "connectionType", + "type": "string", + "in": "path", + "description": "The type of allowed connections (Internal, External)", + "required": true, + "enum": ["Internal", "External"], + "x-ms-enum": { + "name": "connectionType", + "modelAsString": true, + "values": [ + { + "value": "Internal" + }, + { + "value": "External" + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json index a3ecb74af580..e3e35a3b0e8a 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json @@ -1,237 +1,237 @@ -{ - "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": { - "/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DiscoveredSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DiscoveredSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/DiscoveredSecuritySolutionName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DiscoveredSecuritySolution" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/definitions/Resource" - }, - { - "$ref": "../../../common/v1/types.json#/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"] - } - }, - "parameters": { - "DiscoveredSecuritySolutionName": { - "name": "discoveredSecuritySolutionName", - "type": "string", - "in": "path", - "required": true, - "description": "Name of a discovered security solution.", - "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": { + "/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/DiscoveredSecuritySolutionName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiscoveredSecuritySolution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "../../../common/v1/types.json#/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"] + } + }, + "parameters": { + "DiscoveredSecuritySolutionName": { + "name": "discoveredSecuritySolutionName", + "type": "string", + "in": "path", + "required": true, + "description": "Name of a discovered security solution.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json index 61e904711b50..cf17f82d8844 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/EnforceAdaptiveNetworkHardeningRules_example.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1", - "adaptiveNetworkHardeningResourceName": "default", - "adaptiveNetworkHardeningEnforceAction": "enforce", - "body": { - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg2" - ] - } - }, - "responses": { - "200": { - "description": "OK." - }, - "202": { - "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "rg1", + "resourceNamespace": "Microsoft.Compute", + "resourceType": "virtualMachines", + "resourceName": "vm1", + "adaptiveNetworkHardeningResourceName": "default", + "adaptiveNetworkHardeningEnforceAction": "enforce", + "body": { + "rules": [ + { + "name": "rule1", + "direction": "Inbound", + "destinationPort": 3389, + "protocols": [ + "TCP" + ], + "ipAddresses": [ + "100.10.1.1", + "200.20.2.2", + "81.199.3.0/24" + ] + }, + { + "name": "rule2", + "direction": "Inbound", + "destinationPort": 22, + "protocols": [ + "TCP" + ], + "ipAddresses": [] + } + ], + "networkSecurityGroups": [ + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg2" + ] + } + }, + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously." + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json index 9617da0549af..bf948663bb06 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/GetAdaptiveNetworkHardening_example.json @@ -1,62 +1,62 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1", - "adaptiveNetworkHardeningResourceName": "default" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", - "name": "default", - "type": "Microsoft.Security/adaptiveNetworkHardenings", - "properties": { - "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "effectiveNetworkSecurityGroups": [ - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" - ] - }, - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg2/providers/Microsoft.Network/networkInterfaces/nic2", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nicNsg" - ] - } - ] - } - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "rg1", + "resourceNamespace": "Microsoft.Compute", + "resourceType": "virtualMachines", + "resourceName": "vm1", + "adaptiveNetworkHardeningResourceName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", + "name": "default", + "type": "Microsoft.Security/adaptiveNetworkHardenings", + "properties": { + "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", + "rules": [ + { + "name": "rule1", + "direction": "Inbound", + "destinationPort": 3389, + "protocols": [ + "TCP" + ], + "ipAddresses": [ + "100.10.1.1", + "200.20.2.2", + "81.199.3.0/24" + ] + }, + { + "name": "rule2", + "direction": "Inbound", + "destinationPort": 22, + "protocols": [ + "TCP" + ], + "ipAddresses": [] + } + ], + "effectiveNetworkSecurityGroups": [ + { + "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", + "networkSecurityGroups": [ + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" + ] + }, + { + "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg2/providers/Microsoft.Network/networkInterfaces/nic2", + "networkSecurityGroups": [ + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nicNsg" + ] + } + ] + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json index d6e05253d756..aacc98914ae7 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AdaptiveNetworkHardenings/ListByExtendedResourceAdaptiveNetworkHardenings_example.json @@ -1,65 +1,65 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "resourceGroupName": "rg1", - "resourceNamespace": "Microsoft.Compute", - "resourceType": "virtualMachines", - "resourceName": "vm1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", - "name": "default", - "type": "Microsoft.Security/adaptiveNetworkHardenings", - "properties": { - "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", - "rules": [ - { - "name": "rule1", - "direction": "Inbound", - "destinationPort": 3389, - "protocols": [ - "TCP" - ], - "ipAddresses": [ - "100.10.1.1", - "200.20.2.2", - "81.199.3.0/24" - ] - }, - { - "name": "rule2", - "direction": "Inbound", - "destinationPort": 22, - "protocols": [ - "TCP" - ], - "ipAddresses": [] - } - ], - "effectiveNetworkSecurityGroups": [ - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" - ] - }, - { - "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic2", - "networkSecurityGroups": [ - "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg2" - ] - } - ] - } - } - ] - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "rg1", + "resourceNamespace": "Microsoft.Compute", + "resourceType": "virtualMachines", + "resourceName": "vm1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.Security/adaptiveNetworkHardenings/default", + "name": "default", + "type": "Microsoft.Security/adaptiveNetworkHardenings", + "properties": { + "rulesCalculationTime": "2018-08-15T00:00:00.0000000Z", + "rules": [ + { + "name": "rule1", + "direction": "Inbound", + "destinationPort": 3389, + "protocols": [ + "TCP" + ], + "ipAddresses": [ + "100.10.1.1", + "200.20.2.2", + "81.199.3.0/24" + ] + }, + { + "name": "rule2", + "direction": "Inbound", + "destinationPort": 22, + "protocols": [ + "TCP" + ], + "ipAddresses": [] + } + ], + "effectiveNetworkSecurityGroups": [ + { + "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1", + "networkSecurityGroups": [ + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg", + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/subnetNsg" + ] + }, + { + "networkInterface": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/rg1/providers/Microsoft.Network/networkInterfaces/nic2", + "networkSecurityGroups": [ + "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nicNsg2" + ] + } + ] + } + } + ] + } + } + } } \ No newline at end of file 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 de4fcbecda50..25aada04835b 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,74 +1,74 @@ -{ - "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, - "isIncident": false, - "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" - }], - "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" - } - } - } - } +{ + "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, + "isIncident": false, + "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" + }], + "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" + } + } + } + } } \ 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 5c8733f3c5e9..2af79c663560 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,73 +1,73 @@ -{ - "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, - "isIncident": false, - "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" - }], - "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" - } - } - } - } +{ + "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, + "isIncident": false, + "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" + }], + "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" + } + } + } + } } \ 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 eeb2ceb5b449..d1522b373b48 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,75 +1,75 @@ -{ - "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, - "isIncident": false, - "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" - }], - "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" - } - }] - } - } - } +{ + "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, + "isIncident": false, + "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" + }], + "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" + } + }] + } + } + } } \ 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 a9cd699182c2..d9c3da31cb1a 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,74 +1,74 @@ -{ - "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, - "isIncident": false, - "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" - }], - "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" - } - }] - } - } - } +{ + "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, + "isIncident": false, + "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" + }], + "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" + } + }] + } + } + } } \ 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 0eb1e983812b..058ebfbcde25 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,153 +1,153 @@ -{ - "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, - "isIncident": false, - "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" - }], - "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" - } - }, - { - "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" - }], - "correlationKey": "CCso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0sWqs=" - } - } - ] - } - } - } +{ + "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, + "isIncident": false, + "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" + }], + "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" + } + }, + { + "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" + }], + "correlationKey": "CCso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0sWqs=" + } + } + ] + } + } + } } \ 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 434007f77424..7fd284c0026e 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,157 +1,157 @@ -{ - "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, - "isIncident": false, - "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" - }], - "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" - } - }, - { - "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" - }], - "correlationKey": "6Lso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9MY1" - } - } - ] - } - } - } +{ + "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, + "isIncident": false, + "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" + }], + "correlationKey": "Rkso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9Jk=" + } + }, + { + "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" + }], + "correlationKey": "6Lso6LFWxzCll5tqrk4hnrBJ+MY1BX806W6q6+0s9MY1" + } + } + ] + } + } + } } \ 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/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json index 6fdbab08e2c8..5b78c56df89d 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json @@ -1,65 +1,65 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", - "ascLocation": "centralus" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.Security/locations/allowedConnections", - "properties": { - "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", - "connectableResources": [ - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "inboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ], - "outboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ] - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "inboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ], - "outboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ] - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", - "inboundConnectedResources": [], - "outboundConnectedResources": [] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", - "name": "Internal", - "location": "centralus" - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", + "ascLocation": "centralus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Security/locations/allowedConnections", + "properties": { + "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", + "connectableResources": [ + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", + "inboundConnectedResources": [], + "outboundConnectedResources": [] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", + "name": "Internal", + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json index 6ed76ac9eac4..8e9e34cf7eb6 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json @@ -1,64 +1,64 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.Security/locations/allowedConnections", - "properties": { - "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", - "connectableResources": [ - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "inboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ], - "outboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ] - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "inboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ], - "outboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ] - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", - "inboundConnectedResources": [], - "outboundConnectedResources": [] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", - "name": "Internal", - "location": "centralus" - } - ] - } - } - } -} +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Security/locations/allowedConnections", + "properties": { + "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", + "connectableResources": [ + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", + "inboundConnectedResources": [], + "outboundConnectedResources": [] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", + "name": "Internal", + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json index b99b6d83d559..f18c018d44ee 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json @@ -1,63 +1,63 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", - "resourceGroupName": "myResourceGroup", - "ascLocation": "centralus", - "connectionType": "Internal" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.Security/locations/allowedConnections", - "properties": { - "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", - "connectableResources": [ - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "inboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ], - "outboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ] - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", - "inboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ], - "outboundConnectedResources": [ - { - "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", - "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", - "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" - } - ] - }, - { - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", - "inboundConnectedResources": [], - "outboundConnectedResources": [] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", - "name": "Internal", - "location": "centralus" - } - } - } +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", + "resourceGroupName": "myResourceGroup", + "ascLocation": "centralus", + "connectionType": "Internal" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Security/locations/allowedConnections", + "properties": { + "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", + "connectableResources": [ + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", + "inboundConnectedResources": [], + "outboundConnectedResources": [] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", + "name": "Internal", + "location": "centralus" + } + } + } } \ 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/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/examples/Topology/GetTopologySubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopologySubscriptionLocation_example.json index 4263ef6bcd08..4365714df339 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopologySubscriptionLocation_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopologySubscriptionLocation_example.json @@ -1,64 +1,64 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", - "ascLocation": "centralus" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", - "topologyResources": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet", - "severity": "Healthy", - "networkZones": "Internal", - "recommendationsExist": false, - "topologyScore": 0, - "location": "westus", - "children": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet" - } - ] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets", - "name": "vnets", - "type": "Microsoft.Security/locations/topologies", - "location": "westus" - }, - { - "properties": { - "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", - "topologyResources": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet", - "severity": "Healthy", - "networkZones": "Internal", - "recommendationsExist": false, - "topologyScore": 5, - "location": "westus", - "parents": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet" - } - ] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/subnets", - "name": "subnets", - "type": "Microsoft.Security/locations/topologies", - "location": "westus" - } - ] - } - - } - } -} +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", + "ascLocation": "centralus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", + "topologyResources": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet", + "severity": "Healthy", + "networkZones": "Internal", + "recommendationsExist": false, + "topologyScore": 0, + "location": "westus", + "children": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet" + } + ] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets", + "name": "vnets", + "type": "Microsoft.Security/locations/topologies", + "location": "westus" + }, + { + "properties": { + "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", + "topologyResources": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet", + "severity": "Healthy", + "networkZones": "Internal", + "recommendationsExist": false, + "topologyScore": 5, + "location": "westus", + "parents": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet" + } + ] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/subnets", + "name": "subnets", + "type": "Microsoft.Security/locations/topologies", + "location": "westus" + } + ] + } + + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopologySubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopologySubscription_example.json index 18b3e965b2a2..4de5f4173c7a 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopologySubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopologySubscription_example.json @@ -1,63 +1,63 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", - "topologyResources": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet", - "severity": "Healthy", - "networkZones": "Internal", - "recommendationsExist": false, - "topologyScore": 0, - "location": "westus", - "children": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet" - } - ] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets", - "name": "vnets", - "type": "Microsoft.Security/locations/topologies", - "location": "westus" - }, - { - "properties": { - "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", - "topologyResources": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet", - "severity": "Healthy", - "networkZones": "Internal", - "recommendationsExist": false, - "topologyScore": 5, - "location": "westus", - "parents": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet" - } - ] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/subnets", - "name": "subnets", - "type": "Microsoft.Security/locations/topologies", - "location": "westus" - } - ] - } - - } - } -} +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", + "topologyResources": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet", + "severity": "Healthy", + "networkZones": "Internal", + "recommendationsExist": false, + "topologyScore": 0, + "location": "westus", + "children": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet" + } + ] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets", + "name": "vnets", + "type": "Microsoft.Security/locations/topologies", + "location": "westus" + }, + { + "properties": { + "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", + "topologyResources": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet", + "severity": "Healthy", + "networkZones": "Internal", + "recommendationsExist": false, + "topologyScore": 5, + "location": "westus", + "parents": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet" + } + ] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/subnets", + "name": "subnets", + "type": "Microsoft.Security/locations/topologies", + "location": "westus" + } + ] + } + + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopology_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopology_example.json index 175255795e5c..6251841be30d 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopology_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/Topology/GetTopology_example.json @@ -1,36 +1,36 @@ -{ - "parameters": { - "api-version": "2015-06-01-preview", - "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", - "resourceGroupName": "myservers", - "ascLocation": "centralus", - "topologyResourceName": "vnets" - }, - "responses": { - "200": { - "body": { - "properties": { - "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", - "topologyResources": [ - { - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet", - "severity": "Healthy", - "networkZones": "InternetFacing", - "recommendationsExist": false, - "topologyScore": 0, - "location": "westus", - "children": [{ - "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet" - } - ] - } - ] - }, - "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets", - "name": "vnets", - "type": "Microsoft.Security/locations/topologies", - "location": "westus" - } - } - } -} +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", + "resourceGroupName": "myservers", + "ascLocation": "centralus", + "topologyResourceName": "vnets" + }, + "responses": { + "200": { + "body": { + "properties": { + "calculatedDateTime": "2018-07-10T13:56:10.5755270Z", + "topologyResources": [ + { + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet", + "severity": "Healthy", + "networkZones": "InternetFacing", + "recommendationsExist": false, + "topologyScore": 0, + "location": "westus", + "children": [{ + "resourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/mysubnet" + } + ] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myservers/providers/Microsoft.Security/locations/centralus/topologies/vnets", + "name": "vnets", + "type": "Microsoft.Security/locations/topologies", + "location": "westus" + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json index 2388cbef7522..5fae80b927c9 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json @@ -1,363 +1,363 @@ -{ - "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": { - "/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExternalSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExternalSecuritySolutionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/ExternalSecuritySolutionsName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ExternalSecuritySolution" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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 whose data is displayed by Azure Security Center.", - "discriminator": "kind", - "properties": {}, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - }, - { - "$ref": "#/definitions/ExternalSecuritySolutionKind" - }, - { - "$ref": "../../../common/v1/types.json#/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": { - "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": { + "/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ExternalSecuritySolutionsName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternalSecuritySolution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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 whose data is displayed by Azure Security Center.", + "discriminator": "kind", + "properties": {}, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "#/definitions/ExternalSecuritySolutionKind" + }, + { + "$ref": "../../../common/v1/types.json#/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": { + "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/2015-06-01-preview/jitNetworkAccessPolicies.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json index 20ea90a49c18..ece915c4c952 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json @@ -1,754 +1,754 @@ -{ - "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": { - "/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPoliciesList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicy" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/JitNetworkAccessPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyName" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyInitiateType" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/JitNetworkAccessPolicyInitiateRequest" - } - ], - "responses": { - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/JitNetworkAccessRequest" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/definitions/Resource" - }, - { - "$ref": "../../../common/v1/types.json#/definitions/Kind" - }, - { - "$ref": "../../../common/v1/types.json#/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 address 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 - } - }, - "parameters": { - "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" - } - } -} +{ + "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": { + "/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicy" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JitNetworkAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyName" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyInitiateType" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/JitNetworkAccessPolicyInitiateRequest" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/JitNetworkAccessRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "../../../common/v1/types.json#/definitions/Kind" + }, + { + "$ref": "../../../common/v1/types.json#/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 address 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 + } + }, + "parameters": { + "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" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/locations.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/locations.json index b35d3a5761c6..c32b84558b91 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/locations.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/locations.json @@ -1,130 +1,130 @@ -{ - "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": { - "/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/AscLocationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/AscLocation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "parameters": { - "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" - } - } -} +{ + "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": { + "/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/AscLocationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/AscLocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "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" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/operations.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/operations.json index a26b4c039db5..f07469d4c4c4 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/operations.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/operations.json @@ -1,134 +1,134 @@ -{ - "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": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "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." - } - } - } - } -} +{ + "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": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "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." + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/tasks.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/tasks.json index 8d527bd9453e..39e87490b284 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/tasks.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/tasks.json @@ -1,422 +1,422 @@ -{ - "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": { - "/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTaskList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTaskList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTask" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - }, - { - "$ref": "#/parameters/TaskUpdateActionType" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTaskList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityTask" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TaskName" - }, - { - "$ref": "#/parameters/TaskUpdateActionType" - } - ], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/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": true, - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Name of the task type" - } - } - } - }, - "parameters": { - "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" - } - } -} +{ + "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": { + "/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + }, + { + "$ref": "#/parameters/TaskUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TaskName" + }, + { + "$ref": "#/parameters/TaskUpdateActionType" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/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": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the task type" + } + } + } + }, + "parameters": { + "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" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/topologies.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/topologies.json index d74acafc57c9..64219dd837a7 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/topologies.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/topologies.json @@ -1,287 +1,287 @@ -{ - "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": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/topologies": { - "get": { - "x-ms-examples": { - "Get topology on a subscription": { - "$ref": "./examples/Topology/GetTopologySubscription_example.json" - } - }, - "tags": ["Topology"], - "description": "Gets a list that allows to build a topology view of a subscription.", - "operationId": "Topology_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TopologyList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/topologies": { - "get": { - "x-ms-examples": { - "Get topology on a subscription from security data location": { - "$ref": "./examples/Topology/GetTopologySubscriptionLocation_example.json" - } - }, - "tags": ["Topology"], - "description": "Gets a list that allows to build a topology view of a subscription and location.", - "operationId": "Topology_ListByHomeRegion", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TopologyList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/topologies/{topologyResourceName}": { - "get": { - "x-ms-examples": { - "Get topology": { - "$ref": "./examples/Topology/GetTopology_example.json" - } - }, - "tags": ["Topology"], - "description": "Gets a specific topology component.", - "operationId": "Topology_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/AscLocation" - }, - { - "$ref": "#/parameters/TopologyResourceName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TopologyResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "TopologyList": { - "type": "object", - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/TopologyResource" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "TopologyResource": { - "type": "object", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "readOnly": true, - "$ref": "#/definitions/TopologyResourceProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - }, - { - "$ref": "../../../common/v1/types.json#/definitions/Location" - } - ] - }, - "TopologyResourceProperties": { - "type": "object", - "properties": { - "calculatedDateTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "The UTC time on which the topology was calculated" - }, - "topologyResources": { - "type": "array", - "readOnly": true, - "description": "Azure resources which are part of this topology resource", - "items": { - "$ref": "#/definitions/TopologySingleResource" - } - } - } - }, - "TopologySingleResource": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "readOnly": true, - "description": "Azure resource id" - }, - "severity": { - "type": "string", - "readOnly": true, - "description": "The security severity of the resource" - }, - "recommendationsExist": { - "type": "boolean", - "readOnly": true, - "description": "Indicates if the resource has security recommendations" - }, - "networkZones": { - "type": "string", - "readOnly": true, - "description": "Indicates the resource connectivity level to the Internet (InternetFacing, Internal ,etc.)" - }, - "topologyScore": { - "type": "integer", - "readOnly": true, - "description": "Score of the resource based on its security severity" - }, - "location": { - "type": "string", - "readOnly": true, - "description": "The location of this resource" - }, - "parents": { - "type": "array", - "readOnly": true, - "description": "Azure resources connected to this resource which are in higher level in the topology view", - "items": { - "$ref": "#/definitions/TopologySingleResourceParent" - } - }, - "children": { - "type": "array", - "readOnly": true, - "description": "Azure resources connected to this resource which are in lower level in the topology view", - "items": { - "$ref": "#/definitions/TopologySingleResourceChild" - } - } - } - }, - "TopologySingleResourceParent": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "readOnly": true, - "description": "Azure resource id which serves as parent resource in topology view" - } - } - }, - "TopologySingleResourceChild": { - "type": "object", - "properties": { - "resourceId": { - "type": "string", - "readOnly": true, - "description": "Azure resource id which serves as child resource in topology view" - } - } - } - }, - "parameters": { - "TopologyResourceName": { - "name": "topologyResourceName", - "in": "path", - "description": "Name of a topology resources collection.", - "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": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/topologies": { + "get": { + "x-ms-examples": { + "Get topology on a subscription": { + "$ref": "./examples/Topology/GetTopologySubscription_example.json" + } + }, + "tags": ["Topology"], + "description": "Gets a list that allows to build a topology view of a subscription.", + "operationId": "Topology_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopologyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/topologies": { + "get": { + "x-ms-examples": { + "Get topology on a subscription from security data location": { + "$ref": "./examples/Topology/GetTopologySubscriptionLocation_example.json" + } + }, + "tags": ["Topology"], + "description": "Gets a list that allows to build a topology view of a subscription and location.", + "operationId": "Topology_ListByHomeRegion", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopologyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/topologies/{topologyResourceName}": { + "get": { + "x-ms-examples": { + "Get topology": { + "$ref": "./examples/Topology/GetTopology_example.json" + } + }, + "tags": ["Topology"], + "description": "Gets a specific topology component.", + "operationId": "Topology_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/TopologyResourceName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopologyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "TopologyList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TopologyResource" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "TopologyResource": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/TopologyResourceProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "../../../common/v1/types.json#/definitions/Location" + } + ] + }, + "TopologyResourceProperties": { + "type": "object", + "properties": { + "calculatedDateTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The UTC time on which the topology was calculated" + }, + "topologyResources": { + "type": "array", + "readOnly": true, + "description": "Azure resources which are part of this topology resource", + "items": { + "$ref": "#/definitions/TopologySingleResource" + } + } + } + }, + "TopologySingleResource": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "readOnly": true, + "description": "Azure resource id" + }, + "severity": { + "type": "string", + "readOnly": true, + "description": "The security severity of the resource" + }, + "recommendationsExist": { + "type": "boolean", + "readOnly": true, + "description": "Indicates if the resource has security recommendations" + }, + "networkZones": { + "type": "string", + "readOnly": true, + "description": "Indicates the resource connectivity level to the Internet (InternetFacing, Internal ,etc.)" + }, + "topologyScore": { + "type": "integer", + "readOnly": true, + "description": "Score of the resource based on its security severity" + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The location of this resource" + }, + "parents": { + "type": "array", + "readOnly": true, + "description": "Azure resources connected to this resource which are in higher level in the topology view", + "items": { + "$ref": "#/definitions/TopologySingleResourceParent" + } + }, + "children": { + "type": "array", + "readOnly": true, + "description": "Azure resources connected to this resource which are in lower level in the topology view", + "items": { + "$ref": "#/definitions/TopologySingleResourceChild" + } + } + } + }, + "TopologySingleResourceParent": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "readOnly": true, + "description": "Azure resource id which serves as parent resource in topology view" + } + } + }, + "TopologySingleResourceChild": { + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "readOnly": true, + "description": "Azure resource id which serves as child resource in topology view" + } + } + } + }, + "parameters": { + "TopologyResourceName": { + "name": "topologyResourceName", + "in": "path", + "description": "Name of a topology resources collection.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json index f528aaa9ae35..9b886f5575b5 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json @@ -1,152 +1,152 @@ -{ - "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": { - "/{resourceId}/providers/Microsoft.Security/advancedThreatProtectionSettings/{settingName}": { - "get": { - "x-ms-examples": { - "Gets the Advanced Threat Protection settings for the specified resource.": { - "$ref": "./examples/AdvancedThreatProtection/GetAdvancedThreatProtectionSettings_example.json" - } - }, - "tags": [ "AdvancedThreatProtection" ], - "description": "Gets the Advanced Threat Protection settings for the specified resource.", - "operationId": "AdvancedThreatProtection_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - }, - { - "$ref": "#/parameters/AdvancedThreatProtectionSettingName" - } - ], - "responses": { - "200": { - "description": "Successful request to get Advanced Threat Protection settings.", - "schema": { - "$ref": "#/definitions/AdvancedThreatProtectionSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Creates or updates the Advanced Threat Protection settings on a specified resource.": { - "$ref": "./examples/AdvancedThreatProtection/PutAdvancedThreatProtectionSettings_example.json" - } - }, - "tags": [ "AdvancedThreatProtection" ], - "description": "Creates or updates the Advanced Threat Protection settings on a specified resource.", - "operationId": "AdvancedThreatProtection_Create", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - }, - { - "$ref": "#/parameters/AdvancedThreatProtectionSettingName" - }, - { - "$ref": "#/parameters/AdvancedThreatProtectionSetting" - } - ], - "responses": { - "200": { - "description": "Successful request to put Advanced Threat Protection settings.", - "schema": { - "$ref": "#/definitions/AdvancedThreatProtectionSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "AdvancedThreatProtectionProperties": { - "properties": { - "isEnabled": { - "type": "boolean", - "description": "Indicates whether Advanced Threat Protection is enabled." - } - }, - "description": "The Advanced Threat Protection settings." - }, - "AdvancedThreatProtectionSetting": { - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AdvancedThreatProtectionProperties" - } - }, - "description": "The Advanced Threat Protection resource." - } - }, - "parameters": { - "AdvancedThreatProtectionSettingName": { - "name": "settingName", - "in": "path", - "required": true, - "type": "string", - "enum": ["current"], - "description": "Advanced Threat Protection setting name.", - "x-ms-parameter-location": "method" - }, - "AdvancedThreatProtectionSetting": { - "name": "advancedThreatProtectionSetting", - "in": "body", - "required": true, - "description": "Advanced Threat Protection Settings", - "schema": { - "$ref": "#/definitions/AdvancedThreatProtectionSetting" - }, - "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": { + "/{resourceId}/providers/Microsoft.Security/advancedThreatProtectionSettings/{settingName}": { + "get": { + "x-ms-examples": { + "Gets the Advanced Threat Protection settings for the specified resource.": { + "$ref": "./examples/AdvancedThreatProtection/GetAdvancedThreatProtectionSettings_example.json" + } + }, + "tags": [ "AdvancedThreatProtection" ], + "description": "Gets the Advanced Threat Protection settings for the specified resource.", + "operationId": "AdvancedThreatProtection_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceId" + }, + { + "$ref": "#/parameters/AdvancedThreatProtectionSettingName" + } + ], + "responses": { + "200": { + "description": "Successful request to get Advanced Threat Protection settings.", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates the Advanced Threat Protection settings on a specified resource.": { + "$ref": "./examples/AdvancedThreatProtection/PutAdvancedThreatProtectionSettings_example.json" + } + }, + "tags": [ "AdvancedThreatProtection" ], + "description": "Creates or updates the Advanced Threat Protection settings on a specified resource.", + "operationId": "AdvancedThreatProtection_Create", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceId" + }, + { + "$ref": "#/parameters/AdvancedThreatProtectionSettingName" + }, + { + "$ref": "#/parameters/AdvancedThreatProtectionSetting" + } + ], + "responses": { + "200": { + "description": "Successful request to put Advanced Threat Protection settings.", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AdvancedThreatProtectionProperties": { + "properties": { + "isEnabled": { + "type": "boolean", + "description": "Indicates whether Advanced Threat Protection is enabled." + } + }, + "description": "The Advanced Threat Protection settings." + }, + "AdvancedThreatProtectionSetting": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AdvancedThreatProtectionProperties" + } + }, + "description": "The Advanced Threat Protection resource." + } + }, + "parameters": { + "AdvancedThreatProtectionSettingName": { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "enum": ["current"], + "description": "Advanced Threat Protection setting name.", + "x-ms-parameter-location": "method" + }, + "AdvancedThreatProtectionSetting": { + "name": "advancedThreatProtectionSetting", + "in": "body", + "required": true, + "description": "Advanced Threat Protection Settings", + "schema": { + "$ref": "#/definitions/AdvancedThreatProtectionSetting" + }, + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json index 1a30fcad3f90..2c9f0e7975fe 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json @@ -1,213 +1,213 @@ -{ - "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/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AutoProvisioningSettingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/AutoProvisioningSettingName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AutoProvisioningSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/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" - ] - } - }, - "parameters": { - "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" - } - } +{ + "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/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/AutoProvisioningSettingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AutoProvisioningSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/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" + ] + } + }, + "parameters": { + "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" + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/compliances.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/compliances.json index 70e068762b19..cd7cc519040e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/compliances.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/compliances.json @@ -1,190 +1,190 @@ -{ - "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": { - "/{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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/Scope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ComplianceList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{scope}/providers/Microsoft.Security/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/Scope" - }, - { - "$ref": "#/parameters/ComplianceName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Compliance" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/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." - } - } - } - }, - "parameters": { - "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": { + "/{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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/Scope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComplianceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Security/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/Scope" + }, + { + "$ref": "#/parameters/ComplianceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Compliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/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." + } + } + } + }, + "parameters": { + "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/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json index 9a8e4003009d..a4c5eda9f087 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json @@ -1,513 +1,513 @@ -{ - "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": { - "/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups": { - "get": { - "x-ms-examples": { - "List all device security groups for the specified IoT hub resource": { - "$ref": "./examples/DeviceSecurityGroups/ListDeviceSecurityGroups_example.json" - } - }, - "tags": ["DeviceSecurityGroups"], - "description": "Gets the list of device security groups for the specified IoT hub resource.", - "operationId": "DeviceSecurityGroups_List", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DeviceSecurityGroupList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName}": { - "get": { - "x-ms-examples": { - "Get an device security group for the specified IoT hub resource": { - "$ref": "./examples/DeviceSecurityGroups/GetDeviceSecurityGroups_example.json" - } - }, - "tags": [ "DeviceSecurityGroups" ], - "description": "Gets the device security group for the specified IoT hub resource.", - "operationId": "DeviceSecurityGroups_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - }, - { - "$ref": "#/parameters/DeviceSecurityGroupName" - } - ], - "responses": { - "200": { - "description": "Successful request to get security group.", - "schema": { - "$ref": "#/definitions/DeviceSecurityGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update a device security group for the specified IoT hub resource": { - "$ref": "./examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json" - } - }, - "tags": [ "DeviceSecurityGroups" ], - "description": "Creates or updates the device security group on a specified IoT hub resource.", - "operationId": "DeviceSecurityGroups_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - }, - { - "$ref": "#/parameters/DeviceSecurityGroupName" - }, - { - "$ref": "#/parameters/DeviceSecurityGroup" - } - ], - "responses": { - "200": { - "description": "Security group was updated", - "schema": { - "$ref": "#/definitions/DeviceSecurityGroup" - } - }, - "201": { - "description": "Security group was created", - "schema": { - "$ref": "#/definitions/DeviceSecurityGroup" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "x-ms-examples": { - "Delete a device security group for the specified IoT hub resource": { - "$ref": "./examples/DeviceSecurityGroups/DeleteDeviceSecurityGroups_example.json" - } - }, - "tags": ["DeviceSecurityGroups"], - "description": "Deletes the security group", - "operationId": "DeviceSecurityGroups_Delete", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceId" - }, - { - "$ref": "#/parameters/DeviceSecurityGroupName" - } - ], - "responses": { - "200": { - "description": "Device security group has been deleted." - }, - "204": { - "description": "Device security group does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "DeviceSecurityGroupList": { - "type": "object", - "readOnly": true, - "description": "List of device security groups", - "properties": { - "value": { - "type": "array", - "description": "List of device security group objects", - "items": { - "$ref": "#/definitions/DeviceSecurityGroup" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "DeviceSecurityGroup": { - "type": "object", - "description": "The device security group resource", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Device Security group data", - "$ref": "#/definitions/DeviceSecurityGroupProperties" - } - }, - "allOf": [{ - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "DeviceSecurityGroupProperties": { - "type": "object", - "description": "describes properties of a security group.", - "properties": { - "thresholdRules": { - "type": "array", - "description": "A list of threshold custom alert rules.", - "items": { - "type": "object", - "$ref": "#/definitions/ThresholdCustomAlertRule" - } - }, - "timeWindowRules": { - "type": "array", - "description": "A list of time window custom alert rules.", - "items": { - "type": "object", - "$ref": "#/definitions/TimeWindowCustomAlertRule" - } - }, - "allowlistRules": { - "type": "array", - "description": "A list of allow-list custom alert rules.", - "items": { - "type": "object", - "$ref": "#/definitions/AllowlistCustomAlertRule" - } - }, - "denylistRules": { - "type": "array", - "description": "A list of deny-list custom alert rules.", - "items": { - "type": "object", - "$ref": "#/definitions/DenylistCustomAlertRule" - } - } - } - }, - "CustomAlertRule": { - "type": "object", - "description": "A custom alert rule", - "properties": { - "displayName": { - "type": "string", - "readOnly": true, - "description": "The display name of the custom alert." - }, - "description": { - "type": "string", - "readOnly": true, - "description": "The description of the custom alert." - }, - "isEnabled": { - "type": "boolean", - "description": "Whether the custom alert is enabled." - }, - "ruleType": { - "type": "string", - "description": "The type of the custom alert rule." - } - }, - "required": [ - "isEnabled", - "ruleType" - ] - }, - "ListCustomAlertRule": { - "type": "object", - "description": "A List custom alert rule", - "allOf": [{ - "$ref": "#/definitions/CustomAlertRule" - } - ], - "properties": { - "valueType": { - "type": "string", - "description": "The value type of the items in the list", - "enum": ["IpCidr", "String"], - "readOnly": true, - "x-ms-enum": { - "name": "valueType", - "modelAsString": true, - "values": [{ - "value": "IpCidr", - "description": "An IP range in CIDR format (e.g. '192.168.0.1/8')." - }, - { - "value": "String", - "description": "Any string value." - } - ] - } - } - } - }, - "AllowlistCustomAlertRule": { - "type": "object", - "description": "A custom alert rule that checks if a value (depends on the custom alert type) is allowed", - "allOf": [{ - "$ref": "#/definitions/ListCustomAlertRule" - } - ], - "properties": { - "allowlistValues": { - "type": "array", - "description": "The values to allow. The format of the values depends on the rule type.", - "items": { - "type": "string" - } - }, - "ruleType": { - "type": "string", - "description": "The type of the custom alert rule.", - "enum": ["ConnectionToIpNotAllowed", "LocalUserNotAllowed", "ProcessNotAllowed"], - "x-ms-enum": { - "name": "ruleType", - "modelAsString": true, - "values": [{ - "value": "ConnectionToIpNotAllowed", - "description": "Outbound connection to an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation." - }, - { - "value": "LocalUserNotAllowed", - "description": "Login by a local user that isn't allowed. Allow list consists of login names to allow." - }, - { - "value": "ProcessNotAllowed", - "description": "Execution of a process that isn't allowed. Allow list consists of process names to allow." - } - ] - } - } - }, - "required": [ - "allowlistValues" - ] - }, - "DenylistCustomAlertRule": { - "type": "object", - "description": "A custom alert rule that checks if a value (depends on the custom alert type) is denied", - "allOf": [{ - "$ref": "#/definitions/ListCustomAlertRule" - } - ], - "properties": { - "denylistValues": { - "type": "array", - "description": "The values to deny. The format of the values depends on the rule type.", - "items": { - "type": "string" - } - } - }, - "required": [ - "denylistValues" - ] - }, - "ThresholdCustomAlertRule": { - "type": "object", - "description": "A custom alert rule that checks if a value (depends on the custom alert type) is within the given range.", - "allOf": [{ - "$ref": "#/definitions/CustomAlertRule" - } - ], - "properties": { - "minThreshold": { - "type": "integer", - "description": "The minimum threshold." - }, - "maxThreshold": { - "type": "integer", - "description": "The maximum threshold." - } - }, - "required": [ - "minThreshold", - "maxThreshold" - ] - }, - "TimeWindowCustomAlertRule": { - "type": "object", - "description": "A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range.", - "allOf": [ - { - "$ref": "#/definitions/CustomAlertRule" - }, - { - "$ref": "#/definitions/ThresholdCustomAlertRule" - } - ], - "properties": { - "timeWindowSize": { - "type": "string", - "description": "The time window size in iso8601 format.", - "format": "duration" - }, - "ruleType": { - "type": "string", - "description": "The type of the custom alert rule.", - "enum": ["ActiveConnectionsNotInAllowedRange", "AmqpC2DMessagesNotInAllowedRange", "MqttC2DMessagesNotInAllowedRange", "HttpC2DMessagesNotInAllowedRange", "AmqpC2DRejectedMessagesNotInAllowedRange", "MqttC2DRejectedMessagesNotInAllowedRange", "HttpC2DRejectedMessagesNotInAllowedRange", "AmqpD2CMessagesNotInAllowedRange", "MqttD2CMessagesNotInAllowedRange", "HttpD2CMessagesNotInAllowedRange", "DirectMethodInvokesNotInAllowedRange", "FailedLocalLoginsNotInAllowedRange", "FileUploadsNotInAllowedRange", "QueuePurgesNotInAllowedRange", "TwinUpdatesNotInAllowedRange", "UnauthorizedOperationsNotInAllowedRange"], - "x-ms-enum": { - "name": "ruleType", - "modelAsString": true, - "values": [{ - "value": "ActiveConnectionsNotInAllowedRange", - "description": "Number of active connections is not in allowed range." - }, - { - "value": "AmqpC2DMessagesNotInAllowedRange", - "description": "Number of cloud to device messages (AMQP protocol) is not in allowed range." - }, - { - "value": "MqttC2DMessagesNotInAllowedRange", - "description": "Number of cloud to device messages (MQTT protocol) is not in allowed range." - }, - { - "value": "HttpC2DMessagesNotInAllowedRange", - "description": "Number of cloud to device messages (HTTP protocol) is not in allowed range." - }, - { - "value": "AmqpC2DRejectedMessagesNotInAllowedRange", - "description": "Number of rejected cloud to device messages (AMQP protocol) is not in allowed range." - }, - { - "value": "MqttC2DRejectedMessagesNotInAllowedRange", - "description": "Number of rejected cloud to device messages (MQTT protocol) is not in allowed range." - }, - { - "value": "HttpC2DRejectedMessagesNotInAllowedRange", - "description": "Number of rejected cloud to device messages (HTTP protocol) is not in allowed range." - }, - { - "value": "AmqpD2CMessagesNotInAllowedRange", - "description": "Number of device to cloud messages (AMQP protocol) is not in allowed range." - }, - { - "value": "MqttD2CMessagesNotInAllowedRange", - "description": "Number of device to cloud messages (MQTT protocol) is not in allowed range." - }, - { - "value": "HttpD2CMessagesNotInAllowedRange", - "description": "Number of device to cloud messages (HTTP protocol) is not in allowed range." - }, - { - "value": "DirectMethodInvokesNotInAllowedRange", - "description": "Number of direct method invokes is not in allowed range." - }, - { - "value": "FailedLocalLoginsNotInAllowedRange", - "description": "Number of failed local logins is not in allowed range." - }, - { - "value": "FileUploadsNotInAllowedRange", - "description": "Number of file uploads is not in allowed range." - }, - { - "value": "QueuePurgesNotInAllowedRange", - "description": "Number of device queue purges is not in allowed range." - }, - { - "value": "TwinUpdatesNotInAllowedRange", - "description": "Number of twin updates is not in allowed range." - }, - { - "value": "UnauthorizedOperationsNotInAllowedRange", - "description": "Number of unauthorized operations is not in allowed range." - } - ] - } - } - }, - "required": [ - "timeWindowSize" - ] - } - }, - "parameters": { - "DeviceSecurityGroupName": { - "name": "deviceSecurityGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the security group. Please notice that the name is case insensitive.", - "x-ms-parameter-location": "method" - }, - "DeviceSecurityGroup": { - "name": "deviceSecurityGroup", - "in": "body", - "required": true, - "description": "Security group object.", - "schema": { - "$ref": "#/definitions/DeviceSecurityGroup" - }, - "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": { + "/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups": { + "get": { + "x-ms-examples": { + "List all device security groups for the specified IoT hub resource": { + "$ref": "./examples/DeviceSecurityGroups/ListDeviceSecurityGroups_example.json" + } + }, + "tags": ["DeviceSecurityGroups"], + "description": "Gets the list of device security groups for the specified IoT hub resource.", + "operationId": "DeviceSecurityGroups_List", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeviceSecurityGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceId}/providers/Microsoft.Security/deviceSecurityGroups/{deviceSecurityGroupName}": { + "get": { + "x-ms-examples": { + "Get an device security group for the specified IoT hub resource": { + "$ref": "./examples/DeviceSecurityGroups/GetDeviceSecurityGroups_example.json" + } + }, + "tags": [ "DeviceSecurityGroups" ], + "description": "Gets the device security group for the specified IoT hub resource.", + "operationId": "DeviceSecurityGroups_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceId" + }, + { + "$ref": "#/parameters/DeviceSecurityGroupName" + } + ], + "responses": { + "200": { + "description": "Successful request to get security group.", + "schema": { + "$ref": "#/definitions/DeviceSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update a device security group for the specified IoT hub resource": { + "$ref": "./examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json" + } + }, + "tags": [ "DeviceSecurityGroups" ], + "description": "Creates or updates the device security group on a specified IoT hub resource.", + "operationId": "DeviceSecurityGroups_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceId" + }, + { + "$ref": "#/parameters/DeviceSecurityGroupName" + }, + { + "$ref": "#/parameters/DeviceSecurityGroup" + } + ], + "responses": { + "200": { + "description": "Security group was updated", + "schema": { + "$ref": "#/definitions/DeviceSecurityGroup" + } + }, + "201": { + "description": "Security group was created", + "schema": { + "$ref": "#/definitions/DeviceSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a device security group for the specified IoT hub resource": { + "$ref": "./examples/DeviceSecurityGroups/DeleteDeviceSecurityGroups_example.json" + } + }, + "tags": ["DeviceSecurityGroups"], + "description": "Deletes the security group", + "operationId": "DeviceSecurityGroups_Delete", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceId" + }, + { + "$ref": "#/parameters/DeviceSecurityGroupName" + } + ], + "responses": { + "200": { + "description": "Device security group has been deleted." + }, + "204": { + "description": "Device security group does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "DeviceSecurityGroupList": { + "type": "object", + "readOnly": true, + "description": "List of device security groups", + "properties": { + "value": { + "type": "array", + "description": "List of device security group objects", + "items": { + "$ref": "#/definitions/DeviceSecurityGroup" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "DeviceSecurityGroup": { + "type": "object", + "description": "The device security group resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Device Security group data", + "$ref": "#/definitions/DeviceSecurityGroupProperties" + } + }, + "allOf": [{ + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "DeviceSecurityGroupProperties": { + "type": "object", + "description": "describes properties of a security group.", + "properties": { + "thresholdRules": { + "type": "array", + "description": "A list of threshold custom alert rules.", + "items": { + "type": "object", + "$ref": "#/definitions/ThresholdCustomAlertRule" + } + }, + "timeWindowRules": { + "type": "array", + "description": "A list of time window custom alert rules.", + "items": { + "type": "object", + "$ref": "#/definitions/TimeWindowCustomAlertRule" + } + }, + "allowlistRules": { + "type": "array", + "description": "A list of allow-list custom alert rules.", + "items": { + "type": "object", + "$ref": "#/definitions/AllowlistCustomAlertRule" + } + }, + "denylistRules": { + "type": "array", + "description": "A list of deny-list custom alert rules.", + "items": { + "type": "object", + "$ref": "#/definitions/DenylistCustomAlertRule" + } + } + } + }, + "CustomAlertRule": { + "type": "object", + "description": "A custom alert rule", + "properties": { + "displayName": { + "type": "string", + "readOnly": true, + "description": "The display name of the custom alert." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the custom alert." + }, + "isEnabled": { + "type": "boolean", + "description": "Whether the custom alert is enabled." + }, + "ruleType": { + "type": "string", + "description": "The type of the custom alert rule." + } + }, + "required": [ + "isEnabled", + "ruleType" + ] + }, + "ListCustomAlertRule": { + "type": "object", + "description": "A List custom alert rule", + "allOf": [{ + "$ref": "#/definitions/CustomAlertRule" + } + ], + "properties": { + "valueType": { + "type": "string", + "description": "The value type of the items in the list", + "enum": ["IpCidr", "String"], + "readOnly": true, + "x-ms-enum": { + "name": "valueType", + "modelAsString": true, + "values": [{ + "value": "IpCidr", + "description": "An IP range in CIDR format (e.g. '192.168.0.1/8')." + }, + { + "value": "String", + "description": "Any string value." + } + ] + } + } + } + }, + "AllowlistCustomAlertRule": { + "type": "object", + "description": "A custom alert rule that checks if a value (depends on the custom alert type) is allowed", + "allOf": [{ + "$ref": "#/definitions/ListCustomAlertRule" + } + ], + "properties": { + "allowlistValues": { + "type": "array", + "description": "The values to allow. The format of the values depends on the rule type.", + "items": { + "type": "string" + } + }, + "ruleType": { + "type": "string", + "description": "The type of the custom alert rule.", + "enum": ["ConnectionToIpNotAllowed", "LocalUserNotAllowed", "ProcessNotAllowed"], + "x-ms-enum": { + "name": "ruleType", + "modelAsString": true, + "values": [{ + "value": "ConnectionToIpNotAllowed", + "description": "Outbound connection to an ip that isn't allowed. Allow list consists of ipv4 or ipv6 range in CIDR notation." + }, + { + "value": "LocalUserNotAllowed", + "description": "Login by a local user that isn't allowed. Allow list consists of login names to allow." + }, + { + "value": "ProcessNotAllowed", + "description": "Execution of a process that isn't allowed. Allow list consists of process names to allow." + } + ] + } + } + }, + "required": [ + "allowlistValues" + ] + }, + "DenylistCustomAlertRule": { + "type": "object", + "description": "A custom alert rule that checks if a value (depends on the custom alert type) is denied", + "allOf": [{ + "$ref": "#/definitions/ListCustomAlertRule" + } + ], + "properties": { + "denylistValues": { + "type": "array", + "description": "The values to deny. The format of the values depends on the rule type.", + "items": { + "type": "string" + } + } + }, + "required": [ + "denylistValues" + ] + }, + "ThresholdCustomAlertRule": { + "type": "object", + "description": "A custom alert rule that checks if a value (depends on the custom alert type) is within the given range.", + "allOf": [{ + "$ref": "#/definitions/CustomAlertRule" + } + ], + "properties": { + "minThreshold": { + "type": "integer", + "description": "The minimum threshold." + }, + "maxThreshold": { + "type": "integer", + "description": "The maximum threshold." + } + }, + "required": [ + "minThreshold", + "maxThreshold" + ] + }, + "TimeWindowCustomAlertRule": { + "type": "object", + "description": "A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range.", + "allOf": [ + { + "$ref": "#/definitions/CustomAlertRule" + }, + { + "$ref": "#/definitions/ThresholdCustomAlertRule" + } + ], + "properties": { + "timeWindowSize": { + "type": "string", + "description": "The time window size in iso8601 format.", + "format": "duration" + }, + "ruleType": { + "type": "string", + "description": "The type of the custom alert rule.", + "enum": ["ActiveConnectionsNotInAllowedRange", "AmqpC2DMessagesNotInAllowedRange", "MqttC2DMessagesNotInAllowedRange", "HttpC2DMessagesNotInAllowedRange", "AmqpC2DRejectedMessagesNotInAllowedRange", "MqttC2DRejectedMessagesNotInAllowedRange", "HttpC2DRejectedMessagesNotInAllowedRange", "AmqpD2CMessagesNotInAllowedRange", "MqttD2CMessagesNotInAllowedRange", "HttpD2CMessagesNotInAllowedRange", "DirectMethodInvokesNotInAllowedRange", "FailedLocalLoginsNotInAllowedRange", "FileUploadsNotInAllowedRange", "QueuePurgesNotInAllowedRange", "TwinUpdatesNotInAllowedRange", "UnauthorizedOperationsNotInAllowedRange"], + "x-ms-enum": { + "name": "ruleType", + "modelAsString": true, + "values": [{ + "value": "ActiveConnectionsNotInAllowedRange", + "description": "Number of active connections is not in allowed range." + }, + { + "value": "AmqpC2DMessagesNotInAllowedRange", + "description": "Number of cloud to device messages (AMQP protocol) is not in allowed range." + }, + { + "value": "MqttC2DMessagesNotInAllowedRange", + "description": "Number of cloud to device messages (MQTT protocol) is not in allowed range." + }, + { + "value": "HttpC2DMessagesNotInAllowedRange", + "description": "Number of cloud to device messages (HTTP protocol) is not in allowed range." + }, + { + "value": "AmqpC2DRejectedMessagesNotInAllowedRange", + "description": "Number of rejected cloud to device messages (AMQP protocol) is not in allowed range." + }, + { + "value": "MqttC2DRejectedMessagesNotInAllowedRange", + "description": "Number of rejected cloud to device messages (MQTT protocol) is not in allowed range." + }, + { + "value": "HttpC2DRejectedMessagesNotInAllowedRange", + "description": "Number of rejected cloud to device messages (HTTP protocol) is not in allowed range." + }, + { + "value": "AmqpD2CMessagesNotInAllowedRange", + "description": "Number of device to cloud messages (AMQP protocol) is not in allowed range." + }, + { + "value": "MqttD2CMessagesNotInAllowedRange", + "description": "Number of device to cloud messages (MQTT protocol) is not in allowed range." + }, + { + "value": "HttpD2CMessagesNotInAllowedRange", + "description": "Number of device to cloud messages (HTTP protocol) is not in allowed range." + }, + { + "value": "DirectMethodInvokesNotInAllowedRange", + "description": "Number of direct method invokes is not in allowed range." + }, + { + "value": "FailedLocalLoginsNotInAllowedRange", + "description": "Number of failed local logins is not in allowed range." + }, + { + "value": "FileUploadsNotInAllowedRange", + "description": "Number of file uploads is not in allowed range." + }, + { + "value": "QueuePurgesNotInAllowedRange", + "description": "Number of device queue purges is not in allowed range." + }, + { + "value": "TwinUpdatesNotInAllowedRange", + "description": "Number of twin updates is not in allowed range." + }, + { + "value": "UnauthorizedOperationsNotInAllowedRange", + "description": "Number of unauthorized operations is not in allowed range." + } + ] + } + } + }, + "required": [ + "timeWindowSize" + ] + } + }, + "parameters": { + "DeviceSecurityGroupName": { + "name": "deviceSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security group. Please notice that the name is case insensitive.", + "x-ms-parameter-location": "method" + }, + "DeviceSecurityGroup": { + "name": "deviceSecurityGroup", + "in": "body", + "required": true, + "description": "Security group object.", + "schema": { + "$ref": "#/definitions/DeviceSecurityGroup" + }, + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file 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/DeviceSecurityGroups/DeleteDeviceSecurityGroups_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/DeleteDeviceSecurityGroups_example.json index b103c652d20a..e22d8e3ca318 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/DeleteDeviceSecurityGroups_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/DeleteDeviceSecurityGroups_example.json @@ -1,11 +1,11 @@ -{ - "parameters":{ - "api-version":"2017-08-01-preview", - "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", - "deviceSecurityGroupName":"samplesecuritygroup" - }, - "responses":{ - "200": {}, - "204": {} - } +{ + "parameters":{ + "api-version":"2017-08-01-preview", + "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", + "deviceSecurityGroupName":"samplesecuritygroup" + }, + "responses":{ + "200": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/GetDeviceSecurityGroups_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/GetDeviceSecurityGroups_example.json index 2f64be77464a..0e757d9d90fa 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/GetDeviceSecurityGroups_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/GetDeviceSecurityGroups_example.json @@ -1,192 +1,192 @@ -{ - "parameters":{ - "api-version":"2017-08-01-preview", - "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", - "deviceSecurityGroupName":"samplesecuritygroup" - }, - "responses":{ - "200":{ - "body":{ - "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name":"samplesecuritygroup", - "type":"Microsoft.Security/deviceSecurityGroups", - "properties":{ - "thresholdRules":[], - "timeWindowRules":[ - { - "ruleType":"ActiveConnectionsNotInAllowedRange", - "displayName":"Number of active connections is not in allowed range", - "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"DirectMethodInvokesNotInAllowedRange", - "displayName":"Number of direct method invokes is not in allowed range", - "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FailedLocalLoginsNotInAllowedRange", - "displayName":"Number of failed local logins is not in allowed range", - "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FileUploadsNotInAllowedRange", - "displayName":"Number of file uploads is not in allowed range", - "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"QueuePurgesNotInAllowedRange", - "displayName":"Number of device queue purges is not in allowed range", - "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"TwinUpdatesNotInAllowedRange", - "displayName":"Number of twin updates is not in allowed range", - "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"UnauthorizedOperationsNotInAllowedRange", - "displayName":"Number of unauthorized operations is not in allowed range", - "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - } - ], - "allowlistRules":[ - { - "ruleType":"ConnectionToIpNotAllowed", - "displayName":"Outbound connection to an ip that isn't allowed", - "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", - "isEnabled":false, - "valueType": "IpCidr", - "allowlistValues":[] - }, - { - "ruleType":"LocalUserNotAllowed", - "displayName":"Login by a local user that isn't allowed", - "description":"Get an alert when a local user that isn't allowed logins to the device", - "isEnabled":false, - "valueType": "String", - "allowlistValues":[] - }, - { - "ruleType":"ProcessNotAllowed", - "displayName":"Execution of a process that isn't allowed", - "description":"Get an alert when a process that isn't allowed is executed", - "isEnabled":false, - "valueType": "String", - "allowlistValues":[] - } - ], - "denylistRules":[] - } - } - } - } +{ + "parameters":{ + "api-version":"2017-08-01-preview", + "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", + "deviceSecurityGroupName":"samplesecuritygroup" + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", + "name":"samplesecuritygroup", + "type":"Microsoft.Security/deviceSecurityGroups", + "properties":{ + "thresholdRules":[], + "timeWindowRules":[ + { + "ruleType":"ActiveConnectionsNotInAllowedRange", + "displayName":"Number of active connections is not in allowed range", + "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"DirectMethodInvokesNotInAllowedRange", + "displayName":"Number of direct method invokes is not in allowed range", + "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FailedLocalLoginsNotInAllowedRange", + "displayName":"Number of failed local logins is not in allowed range", + "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FileUploadsNotInAllowedRange", + "displayName":"Number of file uploads is not in allowed range", + "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"QueuePurgesNotInAllowedRange", + "displayName":"Number of device queue purges is not in allowed range", + "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"TwinUpdatesNotInAllowedRange", + "displayName":"Number of twin updates is not in allowed range", + "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"UnauthorizedOperationsNotInAllowedRange", + "displayName":"Number of unauthorized operations is not in allowed range", + "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + } + ], + "allowlistRules":[ + { + "ruleType":"ConnectionToIpNotAllowed", + "displayName":"Outbound connection to an ip that isn't allowed", + "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", + "isEnabled":false, + "valueType": "IpCidr", + "allowlistValues":[] + }, + { + "ruleType":"LocalUserNotAllowed", + "displayName":"Login by a local user that isn't allowed", + "description":"Get an alert when a local user that isn't allowed logins to the device", + "isEnabled":false, + "valueType": "String", + "allowlistValues":[] + }, + { + "ruleType":"ProcessNotAllowed", + "displayName":"Execution of a process that isn't allowed", + "description":"Get an alert when a process that isn't allowed is executed", + "isEnabled":false, + "valueType": "String", + "allowlistValues":[] + } + ], + "denylistRules":[] + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/ListDeviceSecurityGroups_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/ListDeviceSecurityGroups_example.json index 6fa37ea9339d..136f807fbd13 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/ListDeviceSecurityGroups_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/ListDeviceSecurityGroups_example.json @@ -1,195 +1,195 @@ -{ - "parameters":{ - "api-version":"2017-08-01-preview", - "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name":"samplesecuritygroup", - "type":"Microsoft.Security/deviceSecurityGroups", - "properties":{ - "thresholdRules":[], - "timeWindowRules":[ - { - "ruleType":"ActiveConnectionsNotInAllowedRange", - "displayName":"Number of active connections is not in allowed range", - "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"DirectMethodInvokesNotInAllowedRange", - "displayName":"Number of direct method invokes is not in allowed range", - "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FailedLocalLoginsNotInAllowedRange", - "displayName":"Number of failed local logins is not in allowed range", - "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FileUploadsNotInAllowedRange", - "displayName":"Number of file uploads is not in allowed range", - "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"QueuePurgesNotInAllowedRange", - "displayName":"Number of device queue purges is not in allowed range", - "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"TwinUpdatesNotInAllowedRange", - "displayName":"Number of twin updates is not in allowed range", - "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"UnauthorizedOperationsNotInAllowedRange", - "displayName":"Number of unauthorized operations is not in allowed range", - "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - } - ], - "allowlistRules":[ - { - "ruleType":"ConnectionToIpNotAllowed", - "displayName":"Outbound connection to an ip that isn't allowed", - "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", - "isEnabled":false, - "valueType": "IpCidr", - "allowlistValues":[] - }, - { - "ruleType":"LocalUserNotAllowed", - "displayName":"Login by a local user that isn't allowed", - "description":"Get an alert when a local user that isn't allowed logins to the device", - "isEnabled":false, - "valueType": "String", - "allowlistValues":[] - }, - { - "ruleType":"ProcessNotAllowed", - "displayName":"Execution of a process that isn't allowed", - "description":"Get an alert when a process that isn't allowed is executed", - "isEnabled":false, - "valueType": "String", - "allowlistValues":[] - } - ], - "denylistRules":[] - } - } - ] - } - } - } +{ + "parameters":{ + "api-version":"2017-08-01-preview", + "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", + "name":"samplesecuritygroup", + "type":"Microsoft.Security/deviceSecurityGroups", + "properties":{ + "thresholdRules":[], + "timeWindowRules":[ + { + "ruleType":"ActiveConnectionsNotInAllowedRange", + "displayName":"Number of active connections is not in allowed range", + "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"DirectMethodInvokesNotInAllowedRange", + "displayName":"Number of direct method invokes is not in allowed range", + "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FailedLocalLoginsNotInAllowedRange", + "displayName":"Number of failed local logins is not in allowed range", + "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FileUploadsNotInAllowedRange", + "displayName":"Number of file uploads is not in allowed range", + "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"QueuePurgesNotInAllowedRange", + "displayName":"Number of device queue purges is not in allowed range", + "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"TwinUpdatesNotInAllowedRange", + "displayName":"Number of twin updates is not in allowed range", + "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"UnauthorizedOperationsNotInAllowedRange", + "displayName":"Number of unauthorized operations is not in allowed range", + "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + } + ], + "allowlistRules":[ + { + "ruleType":"ConnectionToIpNotAllowed", + "displayName":"Outbound connection to an ip that isn't allowed", + "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", + "isEnabled":false, + "valueType": "IpCidr", + "allowlistValues":[] + }, + { + "ruleType":"LocalUserNotAllowed", + "displayName":"Login by a local user that isn't allowed", + "description":"Get an alert when a local user that isn't allowed logins to the device", + "isEnabled":false, + "valueType": "String", + "allowlistValues":[] + }, + { + "ruleType":"ProcessNotAllowed", + "displayName":"Execution of a process that isn't allowed", + "description":"Get an alert when a process that isn't allowed is executed", + "isEnabled":false, + "valueType": "String", + "allowlistValues":[] + } + ], + "denylistRules":[] + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json index 51bf0a6572d1..9aaf21d4ad30 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/DeviceSecurityGroups/PutDeviceSecurityGroups_example.json @@ -1,387 +1,387 @@ -{ - "parameters":{ - "api-version":"2017-08-01-preview", - "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", - "deviceSecurityGroupName":"samplesecuritygroup", - "deviceSecurityGroup": { - "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name":"samplesecuritygroup", - "type":"Microsoft.Security/deviceSecurityGroups", - "properties": { - "timeWindowRules":[ - { - "ruleType":"ActiveConnectionsNotInAllowedRange", - "displayName":"Number of active connections is not in allowed range", - "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled":true, - "minThreshold":0, - "maxThreshold":30, - "timeWindowSize":"PT05M" - } - ] - } - } - }, - "responses":{ - "200":{ - "body":{ - "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name":"samplesecuritygroup", - "type":"Microsoft.Security/deviceSecurityGroups", - "properties":{ - "thresholdRules":[], - "timeWindowRules":[ - { - "ruleType":"ActiveConnectionsNotInAllowedRange", - "displayName":"Number of active connections is not in allowed range", - "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled":true, - "minThreshold":0, - "maxThreshold":30, - "timeWindowSize":"PT05M" - }, - { - "ruleType":"AmqpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"DirectMethodInvokesNotInAllowedRange", - "displayName":"Number of direct method invokes is not in allowed range", - "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FailedLocalLoginsNotInAllowedRange", - "displayName":"Number of failed local logins is not in allowed range", - "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FileUploadsNotInAllowedRange", - "displayName":"Number of file uploads is not in allowed range", - "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"QueuePurgesNotInAllowedRange", - "displayName":"Number of device queue purges is not in allowed range", - "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"TwinUpdatesNotInAllowedRange", - "displayName":"Number of twin updates is not in allowed range", - "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"UnauthorizedOperationsNotInAllowedRange", - "displayName":"Number of unauthorized operations is not in allowed range", - "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - } - ], - "allowlistRules":[ - { - "ruleType":"ConnectionToIpNotAllowed", - "displayName":"Outbound connection to an ip that isn't allowed", - "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", - "isEnabled":false, - "allowlistValues":[] - }, - { - "ruleType":"LocalUserNotAllowed", - "displayName":"Login by a local user that isn't allowed", - "description":"Get an alert when a local user that isn't allowed logins to the device", - "isEnabled":false, - "allowlistValues":[] - }, - { - "ruleType":"ProcessNotAllowed", - "displayName":"Execution of a process that isn't allowed", - "description":"Get an alert when a process that isn't allowed is executed", - "isEnabled":false, - "allowlistValues":[] - } - ], - "denylistRules":[] - } - } - }, - "201":{ - "body":{ - "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", - "name":"samplesecuritygroup", - "type":"Microsoft.Security/deviceSecurityGroups", - "properties":{ - "thresholdRules":[], - "timeWindowRules":[ - { - "ruleType":"ActiveConnectionsNotInAllowedRange", - "displayName":"Number of active connections is not in allowed range", - "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", - "isEnabled":true, - "minThreshold":0, - "maxThreshold":30, - "timeWindowSize":"PT05M" - }, - { - "ruleType":"AmqpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DMessagesNotInAllowedRange", - "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", - "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"AmqpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"MqttD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"HttpD2CMessagesNotInAllowedRange", - "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", - "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"DirectMethodInvokesNotInAllowedRange", - "displayName":"Number of direct method invokes is not in allowed range", - "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FailedLocalLoginsNotInAllowedRange", - "displayName":"Number of failed local logins is not in allowed range", - "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"FileUploadsNotInAllowedRange", - "displayName":"Number of file uploads is not in allowed range", - "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"QueuePurgesNotInAllowedRange", - "displayName":"Number of device queue purges is not in allowed range", - "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"TwinUpdatesNotInAllowedRange", - "displayName":"Number of twin updates is not in allowed range", - "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - }, - { - "ruleType":"UnauthorizedOperationsNotInAllowedRange", - "displayName":"Number of unauthorized operations is not in allowed range", - "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", - "isEnabled":false, - "minThreshold":0, - "maxThreshold":0, - "timeWindowSize":"PT15M" - } - ], - "allowlistRules":[ - { - "ruleType":"ConnectionToIpNotAllowed", - "displayName":"Outbound connection to an ip that isn't allowed", - "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", - "isEnabled":false, - "allowlistValues":[] - }, - { - "ruleType":"LocalUserNotAllowed", - "displayName":"Login by a local user that isn't allowed", - "description":"Get an alert when a local user that isn't allowed logins to the device", - "isEnabled":false, - "allowlistValues":[] - }, - { - "ruleType":"ProcessNotAllowed", - "displayName":"Execution of a process that isn't allowed", - "description":"Get an alert when a process that isn't allowed is executed", - "isEnabled":false, - "allowlistValues":[] - } - ], - "denylistRules":[] - } - } - } - } +{ + "parameters":{ + "api-version":"2017-08-01-preview", + "resourceId":"subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub", + "deviceSecurityGroupName":"samplesecuritygroup", + "deviceSecurityGroup": { + "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", + "name":"samplesecuritygroup", + "type":"Microsoft.Security/deviceSecurityGroups", + "properties": { + "timeWindowRules":[ + { + "ruleType":"ActiveConnectionsNotInAllowedRange", + "displayName":"Number of active connections is not in allowed range", + "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", + "isEnabled":true, + "minThreshold":0, + "maxThreshold":30, + "timeWindowSize":"PT05M" + } + ] + } + } + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", + "name":"samplesecuritygroup", + "type":"Microsoft.Security/deviceSecurityGroups", + "properties":{ + "thresholdRules":[], + "timeWindowRules":[ + { + "ruleType":"ActiveConnectionsNotInAllowedRange", + "displayName":"Number of active connections is not in allowed range", + "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", + "isEnabled":true, + "minThreshold":0, + "maxThreshold":30, + "timeWindowSize":"PT05M" + }, + { + "ruleType":"AmqpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"DirectMethodInvokesNotInAllowedRange", + "displayName":"Number of direct method invokes is not in allowed range", + "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FailedLocalLoginsNotInAllowedRange", + "displayName":"Number of failed local logins is not in allowed range", + "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FileUploadsNotInAllowedRange", + "displayName":"Number of file uploads is not in allowed range", + "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"QueuePurgesNotInAllowedRange", + "displayName":"Number of device queue purges is not in allowed range", + "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"TwinUpdatesNotInAllowedRange", + "displayName":"Number of twin updates is not in allowed range", + "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"UnauthorizedOperationsNotInAllowedRange", + "displayName":"Number of unauthorized operations is not in allowed range", + "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + } + ], + "allowlistRules":[ + { + "ruleType":"ConnectionToIpNotAllowed", + "displayName":"Outbound connection to an ip that isn't allowed", + "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", + "isEnabled":false, + "allowlistValues":[] + }, + { + "ruleType":"LocalUserNotAllowed", + "displayName":"Login by a local user that isn't allowed", + "description":"Get an alert when a local user that isn't allowed logins to the device", + "isEnabled":false, + "allowlistValues":[] + }, + { + "ruleType":"ProcessNotAllowed", + "displayName":"Execution of a process that isn't allowed", + "description":"Get an alert when a process that isn't allowed is executed", + "isEnabled":false, + "allowlistValues":[] + } + ], + "denylistRules":[] + } + } + }, + "201":{ + "body":{ + "id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Devices/iotHubs/sampleiothub/providers/Microsoft.Security/deviceSecurityGroups/samplesecuritygroup", + "name":"samplesecuritygroup", + "type":"Microsoft.Security/deviceSecurityGroups", + "properties":{ + "thresholdRules":[], + "timeWindowRules":[ + { + "ruleType":"ActiveConnectionsNotInAllowedRange", + "displayName":"Number of active connections is not in allowed range", + "description":"Get an alert when the number of active connections of a device in the time window is not in the allowed range", + "isEnabled":true, + "minThreshold":0, + "maxThreshold":30, + "timeWindowSize":"PT05M" + }, + { + "ruleType":"AmqpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DMessagesNotInAllowedRange", + "displayName":"Number of cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (AMQP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (MQTT protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpC2DRejectedMessagesNotInAllowedRange", + "displayName":"Number of rejected cloud to device messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of cloud to device messages (HTTP protocol) that were rejected by the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"AmqpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (AMQP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (AMQP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"MqttD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (MQTT protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (MQTT protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"HttpD2CMessagesNotInAllowedRange", + "displayName":"Number of device to cloud messages (HTTP protocol) is not in allowed range", + "description":"Get an alert when the number of device to cloud messages (HTTP protocol) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"DirectMethodInvokesNotInAllowedRange", + "displayName":"Number of direct method invokes is not in allowed range", + "description":"Get an alert when the number of direct method invokes in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FailedLocalLoginsNotInAllowedRange", + "displayName":"Number of failed local logins is not in allowed range", + "description":"Get an alert when the number of failed local logins on the device in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"FileUploadsNotInAllowedRange", + "displayName":"Number of file uploads is not in allowed range", + "description":"Get an alert when the number of file uploads from the device to the cloud in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"QueuePurgesNotInAllowedRange", + "displayName":"Number of device queue purges is not in allowed range", + "description":"Get an alert when the number of device queue purges in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"TwinUpdatesNotInAllowedRange", + "displayName":"Number of twin updates is not in allowed range", + "description":"Get an alert when the number of twin updates (by the device or the service) in the time window is not in the allowed range", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + }, + { + "ruleType":"UnauthorizedOperationsNotInAllowedRange", + "displayName":"Number of unauthorized operations is not in allowed range", + "description":"Get an alert when the number unauthorized operations in the time window is not in the allowed range. Unauthorized operations are operations that affect the device (or done by it) that fail because of an unauthorized error", + "isEnabled":false, + "minThreshold":0, + "maxThreshold":0, + "timeWindowSize":"PT15M" + } + ], + "allowlistRules":[ + { + "ruleType":"ConnectionToIpNotAllowed", + "displayName":"Outbound connection to an ip that isn't allowed", + "description":"Get an alert when an outbound connection is created between your device and an ip that isn't allowed", + "isEnabled":false, + "allowlistValues":[] + }, + { + "ruleType":"LocalUserNotAllowed", + "displayName":"Login by a local user that isn't allowed", + "description":"Get an alert when a local user that isn't allowed logins to the device", + "isEnabled":false, + "allowlistValues":[] + }, + { + "ruleType":"ProcessNotAllowed", + "displayName":"Execution of a process that isn't allowed", + "description":"Get an alert when a process that isn't allowed is executed", + "isEnabled":false, + "allowlistValues":[] + } + ], + "denylistRules":[] + } + } + } + } } \ 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_full_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_full_example.json index d4364254de7e..6826d1ff4817 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_full_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_full_example.json @@ -1,33 +1,33 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "default1", - "securityContact": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", - "name": "default1", - "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/default1", - "name": "default1", - "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": "default1", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", + "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/default1", + "name": "default1", + "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/CreateSecurityContact_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_min_example.json index b5930c33de0f..9071d3667bb5 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_min_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_min_example.json @@ -1,31 +1,31 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "default2", - "securityContact": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", - "name": "default2", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "chen@contoso.com", - "alertNotifications": "On", - "alertsToAdmins": "On" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", - "name": "default2", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "chen@contoso.com", - "alertNotifications": "On", - "alertsToAdmins": "On" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "default2", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "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 3533a29ff0fd..cfa39960c1c9 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": "default1" - }, - "responses": { - "204": { - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "default1" + }, + "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_full_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_full_example.json index 1b9c0f270c57..4f2560852e53 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_full_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_full_example.json @@ -1,22 +1,22 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "default1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", - "name": "default1", - "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": "default1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", + "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/GetSecurityContact_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_min_example.json index 28acce3b9eda..e3ef6d40c47e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_min_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_min_example.json @@ -1,21 +1,21 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "default2" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", - "name": "default2", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "chen@contoso.com", - "alertNotifications": "On", - "alertsToAdmins": "On" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "default2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "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_full_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json index ee3783208a2f..b894be26d6fa 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_full_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/default1", - "name": "default1", - "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/default1", + "name": "default1", + "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_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json index 60e5de6ae2f6..b416fa948ca8 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json @@ -1,22 +1,22 @@ -{ - "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/default2", - "name": "default2", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "chen@contoso.com", - "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/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "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_full_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_full_example.json index 41505d376402..f1ed7b070044 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_full_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_full_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/default1", - "name": "default1", - "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/default1", - "name": "default1", - "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/default1", + "name": "default1", + "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/default1", + "name": "default1", + "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/SecurityContacts/UpdateSecurityContact_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_min_example.json index ab4168075c92..8ecb447d4746 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_min_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_min_example.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "api-version": "2017-08-01-preview", - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "default2", - "securityContact": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", - "name": "default2", - "type": "Microsoft.Security/securityContacts", - "properties": { - "alertNotifications": "On" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", - "name": "default2", - "type": "Microsoft.Security/securityContacts", - "properties": { - "email": "chen@contoso.com", - "alertNotifications": "On", - "alertsToAdmins": "Off" - } - } - } - } +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "default2", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "alertNotifications": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "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/informationProtectionPolicies.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json index 876bb04dea43..1b276d6702d0 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json @@ -1,289 +1,289 @@ -{ - "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": { - "/{scope}/providers/Microsoft.Security/informationProtectionPolicies/{informationProtectionPolicyName}": { - "get": { - "x-ms-examples": { - "Get the customized information protection policy for a management group": { - "$ref": "./examples/InformationProtectionPolicies/GetCustomInformationProtectionPolicy_example.json" - }, - "Get the effective information protection policy for a management group": { - "$ref": "./examples/InformationProtectionPolicies/GetEffectiveInformationProtectionPolicy_example.json" - } - }, - "tags": ["InformationProtectionPolicies"], - "description": "Details of the information protection policy.", - "operationId": "InformationProtectionPolicies_Get", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/Scope" - }, { - "$ref": "#/parameters/InformationProtectionPolicyName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/InformationProtectionPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create or update an information protection policy for a management group": { - "$ref": "./examples/InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json" - } - }, - "tags": ["InformationProtectionPolicies"], - "description": "Details of the information protection policy.", - "operationId": "InformationProtectionPolicies_CreateOrUpdate", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/Scope" - }, { - "$ref": "#/parameters/InformationProtectionPolicyName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/InformationProtectionPolicy" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/InformationProtectionPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/{scope}/providers/Microsoft.Security/informationProtectionPolicies": { - "get": { - "x-ms-examples": { - "Get information protection policies": { - "$ref": "./examples/InformationProtectionPolicies/ListInformationProtectionPolicies_example.json" - } - }, - "tags": ["InformationProtectionPolicies"], - "description": "Information protection policies of a specific management group.", - "operationId": "InformationProtectionPolicies_List", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/Scope" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/InformationProtectionPolicyList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "InformationProtectionPolicyList": { - "type": "object", - "readOnly": true, - "description": "Information protection policies response.", - "properties": { - "value": { - "type": "array", - "description": "List of information protection policies.", - "items": { - "$ref": "#/definitions/InformationProtectionPolicy" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "InformationProtectionPolicy": { - "type": "object", - "description": "Information protection policy.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Information protection policy data", - "$ref": "#/definitions/InformationProtectionPolicyProperties" - } - }, - "allOf": [{ - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "InformationProtectionPolicyProperties": { - "type": "object", - "description": "describes properties of an information protection policy.", - "properties": { - "lastModifiedUtc": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Describes the last UTC time the policy was modified." - }, - "labels": { - "type": "object", - "description": "Dictionary of sensitivity labels.", - "additionalProperties": { - "type": "object", - "$ref": "#/definitions/SensitivityLabel" - } - }, - "informationTypes": { - "type": "object", - "description": "The sensitivity information types.", - "additionalProperties": { - "type": "object", - "$ref": "#/definitions/InformationType" - } - } - } - }, - "SensitivityLabel": { - "type": "object", - "description": "The sensitivity label.", - "properties": { - "displayName": { - "type": "string", - "description": "The name of the sensitivity label." - }, - "order": { - "type": "number", - "description": "The order of the sensitivity label." - }, - "enabled": { - "type": "boolean", - "description": "Indicates whether the label is enabled or not." - } - } - }, - "InformationType": { - "type": "object", - "description": "The information type.", - "properties": { - "displayName": { - "type": "string", - "description": "The name of the information type." - }, - "order": { - "type": "number", - "description": "The order of the information type." - }, - "recommendedLabelId": { - "type": "string", - "format": "uuid", - "description": "The recommended label id to be associated with this information type." - }, - "enabled": { - "type": "boolean", - "description": "Indicates whether the information type is enabled or not." - }, - "custom": { - "type": "boolean", - "description": "Indicates whether the information type is custom or not." - }, - "keywords": { - "type": "array", - "description": "The information type keywords.", - "items": { - "$ref": "#/definitions/InformationProtectionKeyword" - } - } - } - }, - "InformationProtectionKeyword": { - "type": "object", - "description": "The information type keyword.", - "properties": { - "pattern": { - "type": "string", - "description": "The keyword pattern." - }, - "custom": { - "type": "boolean", - "description": "Indicates whether the keyword is custom or not." - }, - "canBeNumeric": { - "type": "boolean", - "description": "Indicates whether the keyword can be applied on numeric types or not." - }, - "excluded": { - "type": "boolean", - "description": "Indicates whether the keyword is excluded or not." - } - } - } - }, - "parameters": { - "InformationProtectionPolicyName": { - "name": "informationProtectionPolicyName", - "in": "path", - "required": true, - "type": "string", - "enum": ["effective", "custom"], - "description": "Name of the information protection policy.", - "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": { + "/{scope}/providers/Microsoft.Security/informationProtectionPolicies/{informationProtectionPolicyName}": { + "get": { + "x-ms-examples": { + "Get the customized information protection policy for a management group": { + "$ref": "./examples/InformationProtectionPolicies/GetCustomInformationProtectionPolicy_example.json" + }, + "Get the effective information protection policy for a management group": { + "$ref": "./examples/InformationProtectionPolicies/GetEffectiveInformationProtectionPolicy_example.json" + } + }, + "tags": ["InformationProtectionPolicies"], + "description": "Details of the information protection policy.", + "operationId": "InformationProtectionPolicies_Get", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/Scope" + }, { + "$ref": "#/parameters/InformationProtectionPolicyName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InformationProtectionPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or update an information protection policy for a management group": { + "$ref": "./examples/InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json" + } + }, + "tags": ["InformationProtectionPolicies"], + "description": "Details of the information protection policy.", + "operationId": "InformationProtectionPolicies_CreateOrUpdate", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/Scope" + }, { + "$ref": "#/parameters/InformationProtectionPolicyName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InformationProtectionPolicy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/InformationProtectionPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Security/informationProtectionPolicies": { + "get": { + "x-ms-examples": { + "Get information protection policies": { + "$ref": "./examples/InformationProtectionPolicies/ListInformationProtectionPolicies_example.json" + } + }, + "tags": ["InformationProtectionPolicies"], + "description": "Information protection policies of a specific management group.", + "operationId": "InformationProtectionPolicies_List", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/Scope" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/InformationProtectionPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "InformationProtectionPolicyList": { + "type": "object", + "readOnly": true, + "description": "Information protection policies response.", + "properties": { + "value": { + "type": "array", + "description": "List of information protection policies.", + "items": { + "$ref": "#/definitions/InformationProtectionPolicy" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "InformationProtectionPolicy": { + "type": "object", + "description": "Information protection policy.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Information protection policy data", + "$ref": "#/definitions/InformationProtectionPolicyProperties" + } + }, + "allOf": [{ + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "InformationProtectionPolicyProperties": { + "type": "object", + "description": "describes properties of an information protection policy.", + "properties": { + "lastModifiedUtc": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Describes the last UTC time the policy was modified." + }, + "labels": { + "type": "object", + "description": "Dictionary of sensitivity labels.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/SensitivityLabel" + } + }, + "informationTypes": { + "type": "object", + "description": "The sensitivity information types.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/InformationType" + } + } + } + }, + "SensitivityLabel": { + "type": "object", + "description": "The sensitivity label.", + "properties": { + "displayName": { + "type": "string", + "description": "The name of the sensitivity label." + }, + "order": { + "type": "number", + "description": "The order of the sensitivity label." + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether the label is enabled or not." + } + } + }, + "InformationType": { + "type": "object", + "description": "The information type.", + "properties": { + "displayName": { + "type": "string", + "description": "The name of the information type." + }, + "order": { + "type": "number", + "description": "The order of the information type." + }, + "recommendedLabelId": { + "type": "string", + "format": "uuid", + "description": "The recommended label id to be associated with this information type." + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether the information type is enabled or not." + }, + "custom": { + "type": "boolean", + "description": "Indicates whether the information type is custom or not." + }, + "keywords": { + "type": "array", + "description": "The information type keywords.", + "items": { + "$ref": "#/definitions/InformationProtectionKeyword" + } + } + } + }, + "InformationProtectionKeyword": { + "type": "object", + "description": "The information type keyword.", + "properties": { + "pattern": { + "type": "string", + "description": "The keyword pattern." + }, + "custom": { + "type": "boolean", + "description": "Indicates whether the keyword is custom or not." + }, + "canBeNumeric": { + "type": "boolean", + "description": "Indicates whether the keyword can be applied on numeric types or not." + }, + "excluded": { + "type": "boolean", + "description": "Indicates whether the keyword is excluded or not." + } + } + } + }, + "parameters": { + "InformationProtectionPolicyName": { + "name": "informationProtectionPolicyName", + "in": "path", + "required": true, + "type": "string", + "enum": ["effective", "custom"], + "description": "Name of the information protection policy.", + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/pricings.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/pricings.json index 40872d4b614e..54f50e530e06 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/pricings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/pricings.json @@ -1,345 +1,345 @@ -{ - "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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PricingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PricingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/PricingName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Pricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/PricingName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Pricing" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/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"] - } - }, - "parameters": { - "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" - } - } -} +{ + "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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PricingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PricingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/PricingName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/PricingName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Pricing" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/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"] + } + }, + "parameters": { + "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" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/securityContacts.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/securityContacts.json index e78d7df3f508..11c075e40437 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/securityContacts.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/securityContacts.json @@ -1,314 +1,314 @@ -{ - "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/securityContacts": { - "get": { - "x-ms-examples": { - "Update security contact data minimal": { - "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json" - }, - "Update security contact data full": { - "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_List", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityContactList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}": { - "get": { - "x-ms-examples": { - "Get security contact data minimal": { - "$ref": "./examples/SecurityContacts/GetSecurityContact_min_example.json" - }, - "Get security contact data full": { - "$ref": "./examples/SecurityContacts/GetSecurityContact_full_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_Get", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/SecurityContactName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecurityContact" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "put": { - "x-ms-examples": { - "Create security contact data minimal": { - "$ref": "./examples/SecurityContacts/CreateSecurityContact_min_example.json" - }, - "Create security contact data full": { - "$ref": "./examples/SecurityContacts/CreateSecurityContact_full_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_Create", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/SecurityContactName" - }], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - }, - "patch": { - "x-ms-examples": { - "Update security contact data minimal": { - "$ref": "./examples/SecurityContacts/UpdateSecurityContact_min_example.json" - }, - "Update security contact data full": { - "$ref": "./examples/SecurityContacts/UpdateSecurityContact_full_example.json" - } - }, - "tags": ["Security Contacts"], - "description": "Security contact configurations for the subscription", - "operationId": "SecurityContacts_Update", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/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", - "alertNotifications", - "alertsToAdmins" - ] - } - }, - "parameters": { - "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" - } - } +{ + "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/securityContacts": { + "get": { + "x-ms-examples": { + "Update security contact data minimal": { + "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json" + }, + "Update security contact data full": { + "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_List", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContactList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}": { + "get": { + "x-ms-examples": { + "Get security contact data minimal": { + "$ref": "./examples/SecurityContacts/GetSecurityContact_min_example.json" + }, + "Get security contact data full": { + "$ref": "./examples/SecurityContacts/GetSecurityContact_full_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Get", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityContact" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create security contact data minimal": { + "$ref": "./examples/SecurityContacts/CreateSecurityContact_min_example.json" + }, + "Create security contact data full": { + "$ref": "./examples/SecurityContacts/CreateSecurityContact_full_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Create", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/SecurityContactName" + }], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update security contact data minimal": { + "$ref": "./examples/SecurityContacts/UpdateSecurityContact_min_example.json" + }, + "Update security contact data full": { + "$ref": "./examples/SecurityContacts/UpdateSecurityContact_full_example.json" + } + }, + "tags": ["Security Contacts"], + "description": "Security contact configurations for the subscription", + "operationId": "SecurityContacts_Update", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/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", + "alertNotifications", + "alertsToAdmins" + ] + } + }, + "parameters": { + "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" + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/settings.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/settings.json index 190ba7d322ab..445b710a499c 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/settings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/settings.json @@ -1,251 +1,251 @@ -{ - "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/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SettingsList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/SettingName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Setting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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/SettingResource" - } - ] - }, - "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" - } - ] - }, - "SettingResource": { - "type": "object", - "description": "The kind of the security setting", - "properties": { - "kind": { - "type": "string", - "description": "the kind of the settings string (DataExportSetting)", - "enum": ["DataExportSetting", "AlertSuppressionSetting"], - "x-ms-enum": { - "name": "SettingKind", - "modelAsString": true, - "values": [ - { - "value": "DataExportSetting" - }, - { - "value": "AlertSuppressionSetting" - } - ] - } - } - }, - "required": ["kind"], - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "DataExportSettingProperties": { - "type": "object", - "description": "The data export setting properties", - "properties": { - "enabled": { - "type": "boolean", - "description": "Is the data export setting is enabled" - } - }, - "required": ["enabled"] - } - }, - "parameters": { - "SettingName": { - "name": "settingName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of setting: (MCAS/WDATP)", - "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" - } - } -} +{ + "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/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SettingsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/SettingName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Setting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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/SettingResource" + } + ] + }, + "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" + } + ] + }, + "SettingResource": { + "type": "object", + "description": "The kind of the security setting", + "properties": { + "kind": { + "type": "string", + "description": "the kind of the settings string (DataExportSetting)", + "enum": ["DataExportSetting", "AlertSuppressionSetting"], + "x-ms-enum": { + "name": "SettingKind", + "modelAsString": true, + "values": [ + { + "value": "DataExportSetting" + }, + { + "value": "AlertSuppressionSetting" + } + ] + } + } + }, + "required": ["kind"], + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "DataExportSettingProperties": { + "type": "object", + "description": "The data export setting properties", + "properties": { + "enabled": { + "type": "boolean", + "description": "Is the data export setting is enabled" + } + }, + "required": ["enabled"] + } + }, + "parameters": { + "SettingName": { + "name": "settingName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of setting: (MCAS/WDATP)", + "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" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json index daa31f798b0b..63ac4b143fce 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json @@ -1,265 +1,265 @@ -{ - "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/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. If the result is empty, it means that no custom-workspace configuration was set", - "operationId": "WorkspaceSettings_List", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkspaceSettingList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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. If the result is empty, it means that no custom-workspace configuration was set", - "operationId": "WorkspaceSettings_Get", - "parameters": [{ - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/WorkspaceSettingName" - }], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/WorkspaceSetting" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" - }, { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, { - "$ref": "#/parameters/WorkspaceSettingName" - }], - "responses": { - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "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": "../../../common/v1/types.json#/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" - ] - } - }, - "parameters": { - "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" - } - } +{ + "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/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. If the result is empty, it means that no custom-workspace configuration was set", + "operationId": "WorkspaceSettings_List", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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. If the result is empty, it means that no custom-workspace configuration was set", + "operationId": "WorkspaceSettings_Get", + "parameters": [{ + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion" + }, { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, { + "$ref": "#/parameters/WorkspaceSettingName" + }], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "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": "../../../common/v1/types.json#/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" + ] + } + }, + "parameters": { + "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" + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessmentList_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessmentList_example.json index 0a5bd1c785d8..c8b8c1708e43 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessmentList_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessmentList_example.json @@ -1,59 +1,59 @@ -{ - "parameters": { - "api-version": "2019-01-01", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "regulatoryComplianceStandardName": "PCI-DSS-3.2", - "regulatoryComplianceControlName": "1.1" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1/regulatoryComplianceAssessments/968548cb-02b3-8cd2-11f8-0cf64ab1a347", - "name": "968548cb-02b3-8cd2-11f8-0cf64ab1a347", - "type": "Microsoft.Security/regulatoryComplianceAssessment", - "properties": { - "controlName": "1.1", - "description": "Troubleshoot missing scan data on your machines", - "assessmentType": "Assessment", - "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/968548cb-02b3-8cd2-11f8-0cf64ab1a347", - "state": "failed", - "passedResources": 7, - "failedResources": 4, - "skippedResources": 0 - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2/regulatoryComplianceAssessments/3bcd234d-c9c7-c2a2-89e0-c01f419c1a8a", - "name": "3bcd234d-c9c7-c2a2-89e0-c01f419c1a8a", - "type": "Microsoft.Security/regulatoryComplianceAssessment", - "properties": { - "controlName": "1.1", - "description": "Resolve endpoint protection health issues on your machines", - "assessmentType": "Assessment", - "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/3bcd234d-c9c7-c2a2-89e0-c01f419c1a8a", - "state": "skipped", - "passedResources": 0, - "failedResources": 0, - "skippedResources": 10 - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2.1/regulatoryComplianceAssessments/d1db3318-01ff-16de-29eb-28b344515626", - "name": "d1db3318-01ff-16de-29eb-28b344515626", - "type": "Microsoft.Security/regulatoryComplianceAssessment", - "properties": { - "controlName": "1.1", - "description": "Install monitoring agent on your machines", - "assessmentType": "Assessment", - "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/d1db3318-01ff-16de-29eb-28b344515626", - "state": "passed", - "passedResources": 8, - "failedResources": 0, - "skippedResources": 0 - } - }] - } - } - } - } +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "regulatoryComplianceStandardName": "PCI-DSS-3.2", + "regulatoryComplianceControlName": "1.1" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1/regulatoryComplianceAssessments/968548cb-02b3-8cd2-11f8-0cf64ab1a347", + "name": "968548cb-02b3-8cd2-11f8-0cf64ab1a347", + "type": "Microsoft.Security/regulatoryComplianceAssessment", + "properties": { + "controlName": "1.1", + "description": "Troubleshoot missing scan data on your machines", + "assessmentType": "Assessment", + "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/968548cb-02b3-8cd2-11f8-0cf64ab1a347", + "state": "failed", + "passedResources": 7, + "failedResources": 4, + "skippedResources": 0 + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2/regulatoryComplianceAssessments/3bcd234d-c9c7-c2a2-89e0-c01f419c1a8a", + "name": "3bcd234d-c9c7-c2a2-89e0-c01f419c1a8a", + "type": "Microsoft.Security/regulatoryComplianceAssessment", + "properties": { + "controlName": "1.1", + "description": "Resolve endpoint protection health issues on your machines", + "assessmentType": "Assessment", + "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/3bcd234d-c9c7-c2a2-89e0-c01f419c1a8a", + "state": "skipped", + "passedResources": 0, + "failedResources": 0, + "skippedResources": 10 + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2.1/regulatoryComplianceAssessments/d1db3318-01ff-16de-29eb-28b344515626", + "name": "d1db3318-01ff-16de-29eb-28b344515626", + "type": "Microsoft.Security/regulatoryComplianceAssessment", + "properties": { + "controlName": "1.1", + "description": "Install monitoring agent on your machines", + "assessmentType": "Assessment", + "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/d1db3318-01ff-16de-29eb-28b344515626", + "state": "passed", + "passedResources": 8, + "failedResources": 0, + "skippedResources": 0 + } + }] + } + } + } + } diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessment_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessment_example.json index fb587b9143f8..93b725c5b4c1 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessment_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceAssessment_example.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "api-version": "2019-01-01", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "regulatoryComplianceStandardName": "PCI-DSS-3.2", - "regulatoryComplianceControlName": "1.1", - "regulatoryComplianceAssessmentName": "968548cb-02b3-8cd2-11f8-0cf64ab1a347" - }, - "responses": { - "200": { - "body": { - "value": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1/regulatoryComplianceAssessments/968548cb-02b3-8cd2-11f8-0cf64ab1a347", - "name": "968548cb-02b3-8cd2-11f8-0cf64ab1a347", - "type": "Microsoft.Security/regulatoryComplianceAssessment", - "properties": { - "controlName": "1.1", - "description": "Troubleshoot missing scan data on your machines", - "assessmentType": "Assessment", - "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/968548cb-02b3-8cd2-11f8-0cf64ab1a347", - "state": "failed", - "passedResources": 7, - "failedResources": 4, - "skippedResources": 0 - } - } - } - } - } +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "regulatoryComplianceStandardName": "PCI-DSS-3.2", + "regulatoryComplianceControlName": "1.1", + "regulatoryComplianceAssessmentName": "968548cb-02b3-8cd2-11f8-0cf64ab1a347" + }, + "responses": { + "200": { + "body": { + "value": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1/regulatoryComplianceAssessments/968548cb-02b3-8cd2-11f8-0cf64ab1a347", + "name": "968548cb-02b3-8cd2-11f8-0cf64ab1a347", + "type": "Microsoft.Security/regulatoryComplianceAssessment", + "properties": { + "controlName": "1.1", + "description": "Troubleshoot missing scan data on your machines", + "assessmentType": "Assessment", + "assessmentDetailsLink": "https://management.azure.com/subscriptions/a27e854a-8578-4395-8eaf-6fc7849f3050/providers/Microsoft.Security/securityStatuses/968548cb-02b3-8cd2-11f8-0cf64ab1a347", + "state": "failed", + "passedResources": 7, + "failedResources": 4, + "skippedResources": 0 + } + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControlList_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControlList_example.json index c6d14084ec14..6e9b54a5147a 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControlList_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControlList_example.json @@ -1,55 +1,55 @@ -{ - "parameters": { - "api-version": "2019-01-01", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "regulatoryComplianceStandardName": "PCI-DSS-3.2" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1", - "name": "1.1", - "type": "Microsoft.Security/regulatoryComplianceControl", - "properties": { - "standardName": "PCI-DSS-3.2", - "description": "Common Criteria Related to Organization and Management.", - "state": "failed", - "passedAssessments": 7, - "failedAssessments": 4, - "skippedAssessments": 0, - "unsupportedAssessments": 0 - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2", - "name": "2", - "type": "Microsoft.Security/regulatoryComplianceControl", - "properties": { - "standardName": "PCI-DSS-3.2", - "description": "Confidential information is protected during the system design, development, testing, implementation, and change processes in accordance with confidentiality commitments and requirements.", - "state": "skipped", - "passedAssessments": 0, - "failedAssessments": 0, - "skippedAssessments": 10, - "unsupportedAssessments": 0 - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2.1", - "name": "2.1", - "type": "Microsoft.Security/regulatoryComplianceControl", - "properties": { - "standardName": "PCI-DSS-3.2", - "description": "Changes to confidentiality commitments and requirements are communicated to internal and external users, vendors, and other third parties whose products and services are included in the system.", - "state": "unsupported", - "passedAssessments": 0, - "failedAssessments": 0, - "skippedAssessments": 0, - "unsupportedAssessments": 0 - } - }] - } - } - } +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "regulatoryComplianceStandardName": "PCI-DSS-3.2" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1", + "name": "1.1", + "type": "Microsoft.Security/regulatoryComplianceControl", + "properties": { + "standardName": "PCI-DSS-3.2", + "description": "Common Criteria Related to Organization and Management.", + "state": "failed", + "passedAssessments": 7, + "failedAssessments": 4, + "skippedAssessments": 0, + "unsupportedAssessments": 0 + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2", + "name": "2", + "type": "Microsoft.Security/regulatoryComplianceControl", + "properties": { + "standardName": "PCI-DSS-3.2", + "description": "Confidential information is protected during the system design, development, testing, implementation, and change processes in accordance with confidentiality commitments and requirements.", + "state": "skipped", + "passedAssessments": 0, + "failedAssessments": 0, + "skippedAssessments": 10, + "unsupportedAssessments": 0 + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/2.1", + "name": "2.1", + "type": "Microsoft.Security/regulatoryComplianceControl", + "properties": { + "standardName": "PCI-DSS-3.2", + "description": "Changes to confidentiality commitments and requirements are communicated to internal and external users, vendors, and other third parties whose products and services are included in the system.", + "state": "unsupported", + "passedAssessments": 0, + "failedAssessments": 0, + "skippedAssessments": 0, + "unsupportedAssessments": 0 + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControl_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControl_example.json index 7827996423b2..c45483de043e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControl_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceControl_example.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "api-version": "2019-01-01", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "regulatoryComplianceStandardName": "PCI-DSS-3.2", - "regulatoryComplianceControlName": "1.1" - }, - "responses": { - "200": { - "body": { - "value": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1", - "name": "1.1", - "type": "Microsoft.Security/regulatoryComplianceControl", - "properties": { - "standardName": "PCI-DSS-3.2", - "description": "Common Criteria Related to Organization and Management", - "state": "failed", - "passedAssessments": 7, - "failedAssessments": 4, - "skippedAssessments": 0, - "unsupportedAssessments": 0 - } - } - } - } - } +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "regulatoryComplianceStandardName": "PCI-DSS-3.2", + "regulatoryComplianceControlName": "1.1" + }, + "responses": { + "200": { + "body": { + "value": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2/regulatoryComplianceControls/1.1", + "name": "1.1", + "type": "Microsoft.Security/regulatoryComplianceControl", + "properties": { + "standardName": "PCI-DSS-3.2", + "description": "Common Criteria Related to Organization and Management", + "state": "failed", + "passedAssessments": 7, + "failedAssessments": 4, + "skippedAssessments": 0, + "unsupportedAssessments": 0 + } + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json index 48f00fa6037c..9c97bb04e544 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json @@ -1,60 +1,60 @@ -{ - "parameters": { - "api-version": "2019-01-01", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" - }, - "responses": { - "200": { - "body": { - "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2", - "name": "PCI-DSS-3.2", - "type": "Microsoft.Security/regulatoryComplianceStandard", - "properties": { - "state": "failed", - "passedControls": 7, - "failedControls": 4, - "skippedControls": 0, - "unsupportedControls": 0 - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/ISO-27001", - "name": "ISO-27001", - "type": "Microsoft.Security/regulatoryComplianceStandard", - "properties": { - "state": "skipped", - "passedControls": 0, - "failedControls": 0, - "skippedControls": 10, - "unsupportedControls": 0 - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/AZURE-CIS", - "name": "AZURE-CIS", - "type": "Microsoft.Security/regulatoryComplianceStandard", - "properties": { - "state": "unsupported", - "passedControls": 0, - "failedControls": 0, - "skippedControls": 0, - "unsupportedControls": 0 - } - }, - { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/SOC-TSP", - "name": "SOC-TSP", - "type": "Microsoft.Security/regulatoryComplianceStandard", - "properties": { - "state": "passed", - "passedControls": 15, - "failedControls": 0, - "skippedControls": 0, - "unsupportedControls": 0 - } - }] - } - } - } +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2", + "name": "PCI-DSS-3.2", + "type": "Microsoft.Security/regulatoryComplianceStandard", + "properties": { + "state": "failed", + "passedControls": 7, + "failedControls": 4, + "skippedControls": 0, + "unsupportedControls": 0 + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/ISO-27001", + "name": "ISO-27001", + "type": "Microsoft.Security/regulatoryComplianceStandard", + "properties": { + "state": "skipped", + "passedControls": 0, + "failedControls": 0, + "skippedControls": 10, + "unsupportedControls": 0 + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/AZURE-CIS", + "name": "AZURE-CIS", + "type": "Microsoft.Security/regulatoryComplianceStandard", + "properties": { + "state": "unsupported", + "passedControls": 0, + "failedControls": 0, + "skippedControls": 0, + "unsupportedControls": 0 + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/SOC-TSP", + "name": "SOC-TSP", + "type": "Microsoft.Security/regulatoryComplianceStandard", + "properties": { + "state": "passed", + "passedControls": 15, + "failedControls": 0, + "skippedControls": 0, + "unsupportedControls": 0 + } + }] + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandard_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandard_example.json index 27954f21caba..462619d5bfd1 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandard_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/RegulatoryCompliance/getRegulatoryComplianceStandard_example.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "api-version": "2019-01-01", - "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "regulatoryComplianceStandardName": "PCI-DSS-3.2" - }, - "responses": { - "200": { - "body": { - "value": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2", - "name": "PCI-DSS-3.2", - "type": "Microsoft.Security/regulatoryComplianceStandard", - "properties": { - "state": "failed", - "passedControls": 7, - "failedControls": 4, - "skippedControls": 0, - "unsupportedControls": 0 - } - } - } - } - } +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "regulatoryComplianceStandardName": "PCI-DSS-3.2" + }, + "responses": { + "200": { + "body": { + "value": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/regulatoryComplianceStandards/PCI-DSS-3.2", + "name": "PCI-DSS-3.2", + "type": "Microsoft.Security/regulatoryComplianceStandard", + "properties": { + "state": "failed", + "passedControls": 7, + "failedControls": 4, + "skippedControls": 0, + "unsupportedControls": 0 + } + } + } + } + } } \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json index 59dfb5bc3409..4e35dba5fdde 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json @@ -1,599 +1,599 @@ -{ - "swagger": "2.0", - "info": { - "title": "Security Center", - "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2019-01-01-preview" - }, - "host": "management.azure.com", - "schemes": ["https"], - "consumes": ["application/json"], - "produces": ["application/json"], - "security": [ - { - "azure_auth": ["user_impersonation"] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards": { - "get": { - "x-ms-examples": { - "Get all supported regulatory compliance standards details and state": { - "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json" - } - }, - "tags": ["RegulatoryCompliance"], - "description": "Supported regulatory compliance standards details and state", - "operationId": "RegulatoryComplianceStandards_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RegulatoryComplianceStandardList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}": { - "get": { - "x-ms-examples": { - "Get selected regulatory compliance standard details and state": { - "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceStandard_example.json" - } - }, - "tags": ["RegulatoryCompliance"], - "description": "Supported regulatory compliance details state for selected standard", - "operationId": "RegulatoryComplianceStandards_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceStandardName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RegulatoryComplianceStandard" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" -} - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls": { - "get": { - "x-ms-examples": { - "Get all regulatory compliance controls details and state for selected standard": { - "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceControlList_example.json" - } - }, - "tags": ["RegulatoryCompliance"], - "description": "All supported regulatory compliance controls details and state for selected standard", - "operationId": "RegulatoryComplianceControls_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceStandardName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RegulatoryComplianceControlList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}": { - "get": { - "x-ms-examples": { - "Get selected regulatory compliance control details and state": { - "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceControl_example.json" - } - }, - "tags": ["RegulatoryCompliance"], - "description": "Selected regulatory compliance control details and state", - "operationId": "RegulatoryComplianceControls_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceStandardName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceControlName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RegulatoryComplianceControl" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments": { - "get": { - "x-ms-examples": { - "Get all assessments mapped to selected regulatory compliance control": { - "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceAssessmentList_example.json" - } - }, - "tags": ["RegulatoryCompliance"], - "description": "Details and state of assessments mapped to selected regulatory compliance control", - "operationId": "RegulatoryComplianceAssessments_List", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceStandardName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceControlName" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RegulatoryComplianceAssessmentList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments/{regulatoryComplianceAssessmentName}": { - "get": { - "x-ms-examples": { - "Get selected regulatory compliance assessment details and state": { - "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceAssessment_example.json" - } - }, - "tags": ["RegulatoryCompliance"], - "description": "Supported regulatory compliance details and state for selected assessment", - "operationId": "RegulatoryComplianceAssessments_Get", - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceStandardName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceControlName" - }, - { - "$ref": "#/parameters/RegulatoryComplianceAssessmentName" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RegulatoryComplianceAssessment" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../../common/v1/types.json#/definitions/CloudError" - } - } - } - } - } - }, - "definitions": { - "RegulatoryComplianceStandardList": { - "description": "List of regulatory compliance standards response", - "required": ["value"], - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RegulatoryComplianceStandard" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "RegulatoryComplianceStandard": { - "type": "object", - "description": "Regulatory compliance standard details and state", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Regulatory compliance standard data", - "$ref": "#/definitions/RegulatoryComplianceStandardProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "RegulatoryComplianceStandardProperties": { - "type": "object", - "description": "Regulatory compliance standard data", - "properties": { - "state": { - "type": "string", - "description": "Aggregative state based on the standard's supported controls states", - "enum": ["Passed", "Failed", "Skipped", "Unsupported"], - "x-ms-enum": { - "name": "state", - "modelAsString": true, - "values": [ - { - "value": "Passed", - "description": "All supported regulatory compliance controls in the given standard have a passed state" - }, - { - "value": "Failed", - "description": "At least one supported regulatory compliance control in the given standard has a state of failed" - }, - { - "value": "Skipped", - "description": "All supported regulatory compliance controls in the given standard have a state of skipped" - }, - { - "value": "Unsupported", - "description": "No supported regulatory compliance data for the given standard" - } - ] - } - }, - "passedControls": { - "readOnly": true, - "type": "integer", - "description": "The number of supported regulatory compliance controls of the given standard with a passed state" - }, - "failedControls": { - "readOnly": true, - "type": "integer", - "description": "The number of supported regulatory compliance controls of the given standard with a failed state" - }, - "skippedControls": { - "readOnly": true, - "type": "integer", - "description": "The number of supported regulatory compliance controls of the given standard with a skipped state" - }, - "unsupportedControls": { - "readOnly": true, - "type": "integer", - "description": "The number of regulatory compliance controls of the given standard which are unsupported by automated assessments" - } - } - }, - "RegulatoryComplianceControlList": { - "description": "List of regulatory compliance controls response", - "required": ["value"], - "properties": { - "value": { - "type": "array", - "description": "List of regulatory compliance controls", - "items": { - "$ref": "#/definitions/RegulatoryComplianceControl" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "RegulatoryComplianceControl": { - "type": "object", - "description": "Regulatory compliance control details and state", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Regulatory compliance control data", - "$ref": "#/definitions/RegulatoryComplianceControlProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "RegulatoryComplianceControlProperties": { - "type": "object", - "description": "Regulatory compliance control data", - "properties": { - "description": { - "readOnly": true, - "type": "string", - "description": "The description of the regulatory compliance control" - }, - "state": { - "type": "string", - "description": "Aggregative state based on the control's supported assessments states", - "enum": ["Passed", "Failed", "Skipped", "Unsupported"], - "x-ms-enum": { - "name": "state", - "modelAsString": true, - "values": [ - { - "value": "Passed", - "description": "All supported regulatory compliance assessments in the given control have a passed state" - }, - { - "value": "Failed", - "description": "At least one supported regulatory compliance assessment in the given control has a state of failed" - }, - { - "value": "Skipped", - "description": "All supported regulatory compliance assessments in the given control have a state of skipped" - }, - { - "value": "Unsupported", - "description": "No supported regulatory assessment data for the given control" - } - ] - } - }, - "passedAssessments": { - "readOnly": true, - "type": "integer", - "description": "The number of supported regulatory compliance assessments of the given control with a passed state" - }, - "failedAssessments": { - "readOnly": true, - "type": "integer", - "description": "The number of supported regulatory compliance assessments of the given control with a failed state" - }, - "skippedAssessments": { - "readOnly": true, - "type": "integer", - "description": "The number of supported regulatory compliance assessments of the given control with a skipped state" - } - } - }, - "RegulatoryComplianceAssessmentList": { - "description": "List of regulatory compliance assessment response", - "required": ["value"], - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RegulatoryComplianceAssessment" - } - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "The URI to fetch the next page." - } - } - }, - "RegulatoryComplianceAssessment": { - "type": "object", - "description": "Regulatory compliance assessment details and state", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Regulatory compliance assessment data", - "$ref": "#/definitions/RegulatoryComplianceAssessmentProperties" - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/Resource" - } - ] - }, - "RegulatoryComplianceAssessmentProperties": { - "type": "object", - "description": "Regulatory compliance assessment data", - "properties": { - "description": { - "readOnly": true, - "type": "string", - "description": "The description of the regulatory compliance assessment" - }, - "assessmentType": { - "readOnly": true, - "type": "string", - "description": "The expected type of assessment contained in the AssessmentDetailsLink" - }, - "assessmentDetailsLink": { - "readOnly": true, - "type": "string", - "description": "Link to more detailed assessment results data. The response type will be according to the assessmentType field" - }, - "state": { - "type": "string", - "description": "Aggregative state based on the assessment's scanned resources states", - "enum": ["Passed", "Failed", "Skipped", "Unsupported"], - "x-ms-enum": { - "name": "state", - "modelAsString": true, - "values": [ - { - "value": "Passed", - "description": "All related resources passed the given assessment" - }, - { - "value": "Failed", - "description": "The given assessment failed on at least one resource" - }, - { - "value": "Skipped", - "description": "The given assessment skipped on all related resources" - }, - { - "value": "Unsupported", - "description": "The given assessment has no supported resources" - } - ] - } - }, - "passedResources": { - "readOnly": true, - "type": "integer", - "description": "The given assessment's related resources count with passed state." - }, - "failedResources": { - "readOnly": true, - "type": "integer", - "description": "The given assessment's related resources count with failed state." - }, - "skippedResources": { - "readOnly": true, - "type": "integer", - "description": "The given assessment's related resources count with skipped state." - }, - "unsupportedResources": { - "readOnly": true, - "type": "integer", - "description": "The given assessment's related resources count with unsupported state." - } - } - } - }, - "parameters": { - "RegulatoryComplianceStandardName": { - "name": "regulatoryComplianceStandardName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the regulatory compliance standard object", - "x-ms-parameter-location": "method" - }, - "RegulatoryComplianceControlName": { - "name": "regulatoryComplianceControlName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the regulatory compliance control object", - "x-ms-parameter-location": "method" - }, - "RegulatoryComplianceAssessmentName": { - "name": "regulatoryComplianceAssessmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the regulatory compliance assessment object", - "x-ms-parameter-location": "method" - } - } -} +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2019-01-01-preview" + }, + "host": "management.azure.com", + "schemes": ["https"], + "consumes": ["application/json"], + "produces": ["application/json"], + "security": [ + { + "azure_auth": ["user_impersonation"] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards": { + "get": { + "x-ms-examples": { + "Get all supported regulatory compliance standards details and state": { + "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceStandardList_example.json" + } + }, + "tags": ["RegulatoryCompliance"], + "description": "Supported regulatory compliance standards details and state", + "operationId": "RegulatoryComplianceStandards_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegulatoryComplianceStandardList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}": { + "get": { + "x-ms-examples": { + "Get selected regulatory compliance standard details and state": { + "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceStandard_example.json" + } + }, + "tags": ["RegulatoryCompliance"], + "description": "Supported regulatory compliance details state for selected standard", + "operationId": "RegulatoryComplianceStandards_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceStandardName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegulatoryComplianceStandard" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" +} + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls": { + "get": { + "x-ms-examples": { + "Get all regulatory compliance controls details and state for selected standard": { + "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceControlList_example.json" + } + }, + "tags": ["RegulatoryCompliance"], + "description": "All supported regulatory compliance controls details and state for selected standard", + "operationId": "RegulatoryComplianceControls_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceStandardName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegulatoryComplianceControlList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}": { + "get": { + "x-ms-examples": { + "Get selected regulatory compliance control details and state": { + "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceControl_example.json" + } + }, + "tags": ["RegulatoryCompliance"], + "description": "Selected regulatory compliance control details and state", + "operationId": "RegulatoryComplianceControls_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceStandardName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceControlName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegulatoryComplianceControl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments": { + "get": { + "x-ms-examples": { + "Get all assessments mapped to selected regulatory compliance control": { + "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceAssessmentList_example.json" + } + }, + "tags": ["RegulatoryCompliance"], + "description": "Details and state of assessments mapped to selected regulatory compliance control", + "operationId": "RegulatoryComplianceAssessments_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceStandardName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceControlName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ODataFilter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegulatoryComplianceAssessmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments/{regulatoryComplianceAssessmentName}": { + "get": { + "x-ms-examples": { + "Get selected regulatory compliance assessment details and state": { + "$ref": "./examples/RegulatoryCompliance/getRegulatoryComplianceAssessment_example.json" + } + }, + "tags": ["RegulatoryCompliance"], + "description": "Supported regulatory compliance details and state for selected assessment", + "operationId": "RegulatoryComplianceAssessments_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceStandardName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceControlName" + }, + { + "$ref": "#/parameters/RegulatoryComplianceAssessmentName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RegulatoryComplianceAssessment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "RegulatoryComplianceStandardList": { + "description": "List of regulatory compliance standards response", + "required": ["value"], + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RegulatoryComplianceStandard" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "RegulatoryComplianceStandard": { + "type": "object", + "description": "Regulatory compliance standard details and state", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Regulatory compliance standard data", + "$ref": "#/definitions/RegulatoryComplianceStandardProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "RegulatoryComplianceStandardProperties": { + "type": "object", + "description": "Regulatory compliance standard data", + "properties": { + "state": { + "type": "string", + "description": "Aggregative state based on the standard's supported controls states", + "enum": ["Passed", "Failed", "Skipped", "Unsupported"], + "x-ms-enum": { + "name": "state", + "modelAsString": true, + "values": [ + { + "value": "Passed", + "description": "All supported regulatory compliance controls in the given standard have a passed state" + }, + { + "value": "Failed", + "description": "At least one supported regulatory compliance control in the given standard has a state of failed" + }, + { + "value": "Skipped", + "description": "All supported regulatory compliance controls in the given standard have a state of skipped" + }, + { + "value": "Unsupported", + "description": "No supported regulatory compliance data for the given standard" + } + ] + } + }, + "passedControls": { + "readOnly": true, + "type": "integer", + "description": "The number of supported regulatory compliance controls of the given standard with a passed state" + }, + "failedControls": { + "readOnly": true, + "type": "integer", + "description": "The number of supported regulatory compliance controls of the given standard with a failed state" + }, + "skippedControls": { + "readOnly": true, + "type": "integer", + "description": "The number of supported regulatory compliance controls of the given standard with a skipped state" + }, + "unsupportedControls": { + "readOnly": true, + "type": "integer", + "description": "The number of regulatory compliance controls of the given standard which are unsupported by automated assessments" + } + } + }, + "RegulatoryComplianceControlList": { + "description": "List of regulatory compliance controls response", + "required": ["value"], + "properties": { + "value": { + "type": "array", + "description": "List of regulatory compliance controls", + "items": { + "$ref": "#/definitions/RegulatoryComplianceControl" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "RegulatoryComplianceControl": { + "type": "object", + "description": "Regulatory compliance control details and state", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Regulatory compliance control data", + "$ref": "#/definitions/RegulatoryComplianceControlProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "RegulatoryComplianceControlProperties": { + "type": "object", + "description": "Regulatory compliance control data", + "properties": { + "description": { + "readOnly": true, + "type": "string", + "description": "The description of the regulatory compliance control" + }, + "state": { + "type": "string", + "description": "Aggregative state based on the control's supported assessments states", + "enum": ["Passed", "Failed", "Skipped", "Unsupported"], + "x-ms-enum": { + "name": "state", + "modelAsString": true, + "values": [ + { + "value": "Passed", + "description": "All supported regulatory compliance assessments in the given control have a passed state" + }, + { + "value": "Failed", + "description": "At least one supported regulatory compliance assessment in the given control has a state of failed" + }, + { + "value": "Skipped", + "description": "All supported regulatory compliance assessments in the given control have a state of skipped" + }, + { + "value": "Unsupported", + "description": "No supported regulatory assessment data for the given control" + } + ] + } + }, + "passedAssessments": { + "readOnly": true, + "type": "integer", + "description": "The number of supported regulatory compliance assessments of the given control with a passed state" + }, + "failedAssessments": { + "readOnly": true, + "type": "integer", + "description": "The number of supported regulatory compliance assessments of the given control with a failed state" + }, + "skippedAssessments": { + "readOnly": true, + "type": "integer", + "description": "The number of supported regulatory compliance assessments of the given control with a skipped state" + } + } + }, + "RegulatoryComplianceAssessmentList": { + "description": "List of regulatory compliance assessment response", + "required": ["value"], + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RegulatoryComplianceAssessment" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "RegulatoryComplianceAssessment": { + "type": "object", + "description": "Regulatory compliance assessment details and state", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Regulatory compliance assessment data", + "$ref": "#/definitions/RegulatoryComplianceAssessmentProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "RegulatoryComplianceAssessmentProperties": { + "type": "object", + "description": "Regulatory compliance assessment data", + "properties": { + "description": { + "readOnly": true, + "type": "string", + "description": "The description of the regulatory compliance assessment" + }, + "assessmentType": { + "readOnly": true, + "type": "string", + "description": "The expected type of assessment contained in the AssessmentDetailsLink" + }, + "assessmentDetailsLink": { + "readOnly": true, + "type": "string", + "description": "Link to more detailed assessment results data. The response type will be according to the assessmentType field" + }, + "state": { + "type": "string", + "description": "Aggregative state based on the assessment's scanned resources states", + "enum": ["Passed", "Failed", "Skipped", "Unsupported"], + "x-ms-enum": { + "name": "state", + "modelAsString": true, + "values": [ + { + "value": "Passed", + "description": "All related resources passed the given assessment" + }, + { + "value": "Failed", + "description": "The given assessment failed on at least one resource" + }, + { + "value": "Skipped", + "description": "The given assessment skipped on all related resources" + }, + { + "value": "Unsupported", + "description": "The given assessment has no supported resources" + } + ] + } + }, + "passedResources": { + "readOnly": true, + "type": "integer", + "description": "The given assessment's related resources count with passed state." + }, + "failedResources": { + "readOnly": true, + "type": "integer", + "description": "The given assessment's related resources count with failed state." + }, + "skippedResources": { + "readOnly": true, + "type": "integer", + "description": "The given assessment's related resources count with skipped state." + }, + "unsupportedResources": { + "readOnly": true, + "type": "integer", + "description": "The given assessment's related resources count with unsupported state." + } + } + } + }, + "parameters": { + "RegulatoryComplianceStandardName": { + "name": "regulatoryComplianceStandardName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the regulatory compliance standard object", + "x-ms-parameter-location": "method" + }, + "RegulatoryComplianceControlName": { + "name": "regulatoryComplianceControlName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the regulatory compliance control object", + "x-ms-parameter-location": "method" + }, + "RegulatoryComplianceAssessmentName": { + "name": "regulatoryComplianceAssessmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the regulatory compliance assessment object", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/common/v1/types.json b/specification/security/resource-manager/common/v1/types.json index e8b7ace59b60..d39288b12ec5 100644 --- a/specification/security/resource-manager/common/v1/types.json +++ b/specification/security/resource-manager/common/v1/types.json @@ -1,196 +1,196 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0", - "title": "Common types" - }, - "paths": {}, - "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" - } - } - }, - "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" - } - }, - "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", - - "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" - }, - "ResourceId": { - "name": "resourceId", - "in": "path", - "required": true, - "type": "string", - "description": "The identifier of the resource.", - "x-ms-parameter-location": "method" - }, - "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" - }, - "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" - } - } -} +{ + "swagger": "2.0", + "info": { + "version": "1.0", + "title": "Common types" + }, + "paths": {}, + "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" + } + } + }, + "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" + } + }, + "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", + + "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" + }, + "ResourceId": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method" + }, + "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" + }, + "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" + } + } +} diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 9148b8e4f166..4fa9d76a500f 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -1,180 +1,180 @@ -# Security Center - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Security. - ---- - -## Getting Started - -To build the SDK for Security, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -## Suppression - -```yaml -directive: - - suppress: ValidFormats - from: securityContacts.json - where: $.definitions.SecurityContactProperties.properties.email.format - reason: email format is allowed -``` - -### Basic Information - -These are the global settings for the Security API. - -```yaml -title: SecurityCenter -description: API spec for Microsoft.Security (Azure Security Center) resource provider -openapi-type: arm -tag: package-composite-v3 -``` - -## Composite packages - -The following packages may be composed from multiple api-versions. - -### Tag: package-composite-v1 - -These settings apply only when `--tag=package-composite-v1` is specified on the command line. - -```yaml $(tag) == 'package-composite-v1' -input-file: -- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json -- Microsoft.Security/preview/2017-08-01-preview/pricings.json -- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json -- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json -- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json -- Microsoft.Security/preview/2017-08-01-preview/compliances.json -- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json -- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json -- Microsoft.Security/preview/2017-08-01-preview/settings.json -- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json -- Microsoft.Security/preview/2015-06-01-preview/operations.json -- Microsoft.Security/preview/2015-06-01-preview/locations.json -- Microsoft.Security/preview/2015-06-01-preview/tasks.json -- Microsoft.Security/preview/2015-06-01-preview/alerts.json -- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json -- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json -- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json -- Microsoft.Security/preview/2015-06-01-preview/topologies.json -- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json -- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json - -# Needed when there is more than one input file -override-info: - title: SecurityCenter -``` - -### Tag: package-composite-v2 - -These settings apply only when `--tag=package-composite-v2` is specified on the command line. - -```yaml $(tag) == 'package-composite-v2' -input-file: -- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json -- Microsoft.Security/stable/2018-06-01/pricings.json -- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json -- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json -- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json -- Microsoft.Security/preview/2017-08-01-preview/compliances.json -- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json -- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json -- Microsoft.Security/preview/2017-08-01-preview/settings.json -- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json -- Microsoft.Security/preview/2015-06-01-preview/operations.json -- Microsoft.Security/preview/2015-06-01-preview/locations.json -- Microsoft.Security/preview/2015-06-01-preview/tasks.json -- Microsoft.Security/stable/2019-01-01/alerts.json -- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json -- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json -- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json -- Microsoft.Security/preview/2015-06-01-preview/topologies.json -- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json -- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json - -# Needed when there is more than one input file -override-info: - title: SecurityCenter -``` - -### Tag: package-composite-v3 - -These settings apply only when `--tag=package-composite-v3` is specified on the command line. - -```yaml $(tag) == 'package-composite-v3' -input-file: -- Microsoft.Security/stable/2018-06-01/pricings.json -- Microsoft.Security/stable/2019-01-01/alerts.json -- Microsoft.Security/stable/2019-01-01/settings.json -- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json -- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json -- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json -- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json -- Microsoft.Security/preview/2015-06-01-preview/locations.json -- Microsoft.Security/preview/2015-06-01-preview/operations.json -- Microsoft.Security/preview/2015-06-01-preview/tasks.json -- Microsoft.Security/preview/2015-06-01-preview/topologies.json -- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json -- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json -- Microsoft.Security/preview/2017-08-01-preview/compliances.json -- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json -- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json -- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json - -# Needed when there is more than one input file -override-info: - title: SecurityCenter -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -```yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-python - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## C# - -See configuration in [readme.csharp.md](./readme.csharp.md) - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## Node.js - -See configuration in [readme.nodejs.md](./readme.nodejs.md) - -## TypeScript - -See configuration in [readme.typescript.md](./readme.typescript.md) - -## Ruby - -See configuration in [readme.ruby.md](./readme.ruby.md) +# Security Center + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Security. + +--- + +## Getting Started + +To build the SDK for Security, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +## Suppression + +```yaml +directive: + - suppress: ValidFormats + from: securityContacts.json + where: $.definitions.SecurityContactProperties.properties.email.format + reason: email format is allowed +``` + +### Basic Information + +These are the global settings for the Security API. + +```yaml +title: SecurityCenter +description: API spec for Microsoft.Security (Azure Security Center) resource provider +openapi-type: arm +tag: package-composite-v3 +``` + +## Composite packages + +The following packages may be composed from multiple api-versions. + +### Tag: package-composite-v1 + +These settings apply only when `--tag=package-composite-v1` is specified on the command line. + +```yaml $(tag) == 'package-composite-v1' +input-file: +- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json +- Microsoft.Security/preview/2017-08-01-preview/pricings.json +- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json +- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json +- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json +- Microsoft.Security/preview/2017-08-01-preview/compliances.json +- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json +- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json +- Microsoft.Security/preview/2017-08-01-preview/settings.json +- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json +- Microsoft.Security/preview/2015-06-01-preview/operations.json +- Microsoft.Security/preview/2015-06-01-preview/locations.json +- Microsoft.Security/preview/2015-06-01-preview/tasks.json +- Microsoft.Security/preview/2015-06-01-preview/alerts.json +- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json +- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json +- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json +- Microsoft.Security/preview/2015-06-01-preview/topologies.json +- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json +- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json + +# Needed when there is more than one input file +override-info: + title: SecurityCenter +``` + +### Tag: package-composite-v2 + +These settings apply only when `--tag=package-composite-v2` is specified on the command line. + +```yaml $(tag) == 'package-composite-v2' +input-file: +- Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json +- Microsoft.Security/stable/2018-06-01/pricings.json +- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json +- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json +- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json +- Microsoft.Security/preview/2017-08-01-preview/compliances.json +- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json +- Microsoft.Security/preview/2017-08-01-preview/deviceSecurityGroups.json +- Microsoft.Security/preview/2017-08-01-preview/settings.json +- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json +- Microsoft.Security/preview/2015-06-01-preview/operations.json +- Microsoft.Security/preview/2015-06-01-preview/locations.json +- Microsoft.Security/preview/2015-06-01-preview/tasks.json +- Microsoft.Security/stable/2019-01-01/alerts.json +- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json +- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json +- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json +- Microsoft.Security/preview/2015-06-01-preview/topologies.json +- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json +- Microsoft.Security/preview/2015-06-01-preview/adaptiveNetworkHardenings.json + +# Needed when there is more than one input file +override-info: + title: SecurityCenter +``` + +### Tag: package-composite-v3 + +These settings apply only when `--tag=package-composite-v3` is specified on the command line. + +```yaml $(tag) == 'package-composite-v3' +input-file: +- Microsoft.Security/stable/2018-06-01/pricings.json +- Microsoft.Security/stable/2019-01-01/alerts.json +- Microsoft.Security/stable/2019-01-01/settings.json +- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json +- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json +- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json +- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json +- Microsoft.Security/preview/2015-06-01-preview/locations.json +- Microsoft.Security/preview/2015-06-01-preview/operations.json +- Microsoft.Security/preview/2015-06-01-preview/tasks.json +- Microsoft.Security/preview/2015-06-01-preview/topologies.json +- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json +- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json +- Microsoft.Security/preview/2017-08-01-preview/compliances.json +- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json +- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json +- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json + +# Needed when there is more than one input file +override-info: + title: SecurityCenter +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## C# + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Node.js + +See configuration in [readme.nodejs.md](./readme.nodejs.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.md) diff --git a/specification/service-map/resource-manager/readme.md b/specification/service-map/resource-manager/readme.md index e297a5c289b6..f078a14ef932 100644 --- a/specification/service-map/resource-manager/readme.md +++ b/specification/service-map/resource-manager/readme.md @@ -1,111 +1,111 @@ -# ServiceMap - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for ServiceMap. - - - ---- -## Getting Started -To build the SDK for ServiceMap, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration -Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK. - -### Azure Validator Suppressions - -Suppressed Rule | Reason -----------------|-------- -R3023 OperationsAPIImplementation | Service map is sharing RP with Log Analytics, so this operation won't reach ServiceMap's service endpoint. Hence this rule is not applicable. - -```yaml -model-validator: true -semantic-validator: true -azure-validator: true -directive: - suppress: - - R3023 -``` - -### Basic Information -These are the global settings for the ServiceMap API. - -``` yaml -openapi-type: arm -tag: package-2015-11-preview -``` - - -### Tag: package-2015-11-preview - -These settings apply only when `--tag=package-2015-11-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-11-preview' -input-file: -- Microsoft.OperationalInsights/preview/2015-11-01-preview/arm-service-map.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.operationalinsights.servicemap -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights/servicemap -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-11-preview -``` - -### Tag: package-2015-11-preview and java - -These settings apply only when `--tag=package-2015-11-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-11-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.servicemap.v2015_11_01_preview - output-folder: $(azure-libraries-for-java-folder)/servicemap/resource-manager/v2015_11_01_preview -regenerate-manager: true -generate-interface: true -``` - - +# ServiceMap + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ServiceMap. + + + +--- +## Getting Started +To build the SDK for ServiceMap, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration +Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK. + +### Azure Validator Suppressions + +Suppressed Rule | Reason +----------------|-------- +R3023 OperationsAPIImplementation | Service map is sharing RP with Log Analytics, so this operation won't reach ServiceMap's service endpoint. Hence this rule is not applicable. + +```yaml +model-validator: true +semantic-validator: true +azure-validator: true +directive: + suppress: + - R3023 +``` + +### Basic Information +These are the global settings for the ServiceMap API. + +``` yaml +openapi-type: arm +tag: package-2015-11-preview +``` + + +### Tag: package-2015-11-preview + +These settings apply only when `--tag=package-2015-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-11-preview' +input-file: +- Microsoft.OperationalInsights/preview/2015-11-01-preview/arm-service-map.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.operationalinsights.servicemap +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-operationalinsights/servicemap +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-11-preview +``` + +### Tag: package-2015-11-preview and java + +These settings apply only when `--tag=package-2015-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-11-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicemap.v2015_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicemap/resource-manager/v2015_11_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index 12890c9ccf01..c1084d7335b1 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -1,186 +1,186 @@ -# ServiceBus - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for ServiceBus. - - - ---- -## Getting Started -To build the SDK for ServiceBus, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the ServiceBus API. - -``` yaml -openapi-type: arm -tag: package-2017-04 -``` - -### Tag: package-2018-01-preview - -These settings apply only when `--tag=package-2018-01-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-01-preview' -input-file: -- Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json -``` - -### Tag: package-2017-04 - -These settings apply only when `--tag=package-2017-04` is specified on the command line. - - -``` yaml $(tag) == 'package-2017-04' -input-file: -- Microsoft.ServiceBus/stable/2017-04-01/servicebus.json -``` - -Important notes: -On the advice of @fearthecowboy, the `EncodingCaptureDescription` enum previously contained two values [`Avro`,`AvroDeflate`] ; the service has been changed (on 2018-01-17) and will not ever return the `AvroDeflate` value, - however, we have left the value in the enum (in servicebus.json) so that existing clients won't suffer a binary breaking change -The `AvroDeflate` value will likely be removed in a future API version, and at that a breaking binary change may happen. - -### Tag: package-2015-08 - -These settings apply only when `--tag=package-2015-08` is specified on the command line. - -``` yaml $(tag) == 'package-2015-08' -input-file: -- Microsoft.ServiceBus/stable/2015-08-01/servicebus.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_bus'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.ServiceBus - output-folder: $(csharp-sdks-folder)/ServiceBus/Management.ServiceBus/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.servicebus - package-name: azure-mgmt-servicebus - package-version: 0.5.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-servicebus/azure/mgmt/servicebus -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-servicebus -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.servicebus -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicebus -directive: - rename-model: - from: PremiumMessagingRegions - to: PremiumMessagingRegion - -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2015-08 - - tag: package-2017-04 -``` - -### Tag: package-2015-08 and java - -These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.servicebus.v2015_08_01 - output-folder: $(azure-libraries-for-java-folder)/servicebus/resource-manager/v2015_08_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-04 and java - -These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.servicebus.v2017_04_01 - output-folder: $(azure-libraries-for-java-folder)/servicebus/resource-manager/v2017_04_01 -regenerate-manager: true -generate-interface: true -``` - - +# ServiceBus + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ServiceBus. + + + +--- +## Getting Started +To build the SDK for ServiceBus, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the ServiceBus API. + +``` yaml +openapi-type: arm +tag: package-2017-04 +``` + +### Tag: package-2018-01-preview + +These settings apply only when `--tag=package-2018-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-01-preview' +input-file: +- Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json +``` + +### Tag: package-2017-04 + +These settings apply only when `--tag=package-2017-04` is specified on the command line. + + +``` yaml $(tag) == 'package-2017-04' +input-file: +- Microsoft.ServiceBus/stable/2017-04-01/servicebus.json +``` + +Important notes: +On the advice of @fearthecowboy, the `EncodingCaptureDescription` enum previously contained two values [`Avro`,`AvroDeflate`] ; the service has been changed (on 2018-01-17) and will not ever return the `AvroDeflate` value, + however, we have left the value in the enum (in servicebus.json) so that existing clients won't suffer a binary breaking change +The `AvroDeflate` value will likely be removed in a future API version, and at that a breaking binary change may happen. + +### Tag: package-2015-08 + +These settings apply only when `--tag=package-2015-08` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08' +input-file: +- Microsoft.ServiceBus/stable/2015-08-01/servicebus.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_bus'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.ServiceBus + output-folder: $(csharp-sdks-folder)/ServiceBus/Management.ServiceBus/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.servicebus + package-name: azure-mgmt-servicebus + package-version: 0.5.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicebus/azure/mgmt/servicebus +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicebus +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.servicebus +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicebus +directive: + rename-model: + from: PremiumMessagingRegions + to: PremiumMessagingRegion + +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2015-08 + - tag: package-2017-04 +``` + +### Tag: package-2015-08 and java + +These settings apply only when `--tag=package-2015-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2015-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicebus.v2015_08_01 + output-folder: $(azure-libraries-for-java-folder)/servicebus/resource-manager/v2015_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-04 and java + +These settings apply only when `--tag=package-2017-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicebus.v2017_04_01 + output-folder: $(azure-libraries-for-java-folder)/servicebus/resource-manager/v2017_04_01 +regenerate-manager: true +generate-interface: true +``` + + 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/readme.md b/specification/servicefabric/resource-manager/readme.md index 1b8ab11cf894..5a03664c36d4 100644 --- a/specification/servicefabric/resource-manager/readme.md +++ b/specification/servicefabric/resource-manager/readme.md @@ -1,207 +1,207 @@ -# ServiceFabric - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Service Fabric. - - - ---- -## Getting Started -To build the SDK for ServiceFabricManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the ServiceFabricManagementClient API. - -``` yaml -title: ServiceFabricManagementClient -description: Service Fabric Management Client -openapi-type: arm -tag: package-2018-02 - -directive: - - suppress: ListInOperationName - reason: Modifying the operation names would break the backwards compatibility of the API. - - suppress: LongRunningResponseStatusCode - reason: The validation tools do not properly recognize 202 as a supported response code. - - suppress: SummaryAndDescriptionMustNotBeSame - reason: There are a lot of APIs with missing summary content. While it is being worked on disabling this to ensure that we catch and fix other violations. - - suppress: TrackedResourceListByImmediateParent - reason: Proxy resources are not properly evaluated by the validation toolset. - - suppress: DefinitionsPropertiesNamesCamelCase - reason: Modifying the operation names would break the backwards compatibility of the API. - - suppress: EnumInsteadOfBoolean - reason: The boolean properties are actually boolean value in the Service Fabric's application model. - - suppress: TrackedResourceGetOperation - reason: Proxy resources are not properly evaluated by the validation toolset. - - suppress: TrackedResourcePatchOperation - reason: Proxy resources are not properly evaluated by the validation toolset. - - suppress: TrackedResourceListByResourceGroup - reason: Proxy resources are not properly evaluated by the validation toolset. - - suppress: TrackedResourceListBySubscription - reason: Proxy resources are not properly evaluated by the validation toolset. - - suppress: DescriptionAndTitleMissing - reason: There are a lot of APIs with missing titles. While it is being worked on disabling this to ensure that we catch and fix other violations. - - suppress: Example Validations - reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. - - suppress: Example Validations - reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. - -``` - -### Tag: package-2018-02 - -These settings apply only when `--tag=package-2018-02` is specified on the command line. - -``` yaml $(tag) == 'package-2018-02' -input-file: -- Microsoft.ServiceFabric/stable/2018-02-01/cluster.json -- Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json -``` - -### Tag: package-2017-07 - -These settings apply only when `--tag=package-2017-07` is specified on the command line. - -``` yaml $(tag) == 'package-2017-07' -input-file: -- Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json -``` - -### Tag: package-2016-09 - -These settings apply only when `--tag=package-2016-09` is specified on the command line. - -``` yaml $(tag) == 'package-2016-09' -input-file: -- Microsoft.ServiceFabric/stable/2016-09-01/servicefabric.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_fabric'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.ServiceFabric - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/ServiceFabric/Management.ServiceFabric/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.servicefabric - package-name: azure-mgmt-servicefabric - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-servicefabric/azure/mgmt/servicefabric -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-servicefabric -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.servicefabric -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabric -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-07 - - tag: package-2016-09 -``` - -### Tag: package-2017-07 and java - -These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.servicefabric.v2017_07_01_preview - output-folder: $(azure-libraries-for-java-folder)/servicefabric/resource-manager/v2017_07_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-09 and java - -These settings apply only when `--tag=package-2016-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.servicefabric.v2016_09_01 - output-folder: $(azure-libraries-for-java-folder)/servicefabric/resource-manager/v2016_09_01 -regenerate-manager: true -generate-interface: true -``` - - +# ServiceFabric + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Service Fabric. + + + +--- +## Getting Started +To build the SDK for ServiceFabricManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the ServiceFabricManagementClient API. + +``` yaml +title: ServiceFabricManagementClient +description: Service Fabric Management Client +openapi-type: arm +tag: package-2018-02 + +directive: + - suppress: ListInOperationName + reason: Modifying the operation names would break the backwards compatibility of the API. + - suppress: LongRunningResponseStatusCode + reason: The validation tools do not properly recognize 202 as a supported response code. + - suppress: SummaryAndDescriptionMustNotBeSame + reason: There are a lot of APIs with missing summary content. While it is being worked on disabling this to ensure that we catch and fix other violations. + - suppress: TrackedResourceListByImmediateParent + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Modifying the operation names would break the backwards compatibility of the API. + - suppress: EnumInsteadOfBoolean + reason: The boolean properties are actually boolean value in the Service Fabric's application model. + - suppress: TrackedResourceGetOperation + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: TrackedResourcePatchOperation + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: TrackedResourceListByResourceGroup + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: TrackedResourceListBySubscription + reason: Proxy resources are not properly evaluated by the validation toolset. + - suppress: DescriptionAndTitleMissing + reason: There are a lot of APIs with missing titles. While it is being worked on disabling this to ensure that we catch and fix other violations. + - suppress: Example Validations + reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. + - suppress: Example Validations + reason: There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off. + +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.ServiceFabric/stable/2018-02-01/cluster.json +- Microsoft.ServiceFabric/preview/2017-07-01-preview/application.json +``` + +### Tag: package-2017-07 + +These settings apply only when `--tag=package-2017-07` is specified on the command line. + +``` yaml $(tag) == 'package-2017-07' +input-file: +- Microsoft.ServiceFabric/preview/2017-07-01-preview/servicefabric.json +``` + +### Tag: package-2016-09 + +These settings apply only when `--tag=package-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09' +input-file: +- Microsoft.ServiceFabric/stable/2016-09-01/servicefabric.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_fabric'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.ServiceFabric + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/ServiceFabric/Management.ServiceFabric/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.servicefabric + package-name: azure-mgmt-servicefabric + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabric/azure/mgmt/servicefabric +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabric +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.servicefabric +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabric +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-07 + - tag: package-2016-09 +``` + +### Tag: package-2017-07 and java + +These settings apply only when `--tag=package-2017-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabric.v2017_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicefabric/resource-manager/v2017_07_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-09 and java + +These settings apply only when `--tag=package-2016-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabric.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/servicefabric/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true +``` + + 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/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json index e188c663b7a8..7f2184d6377d 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json @@ -1,94 +1,94 @@ -{ - "operationId": "Application_Create", - "description": "This example shows how to create or update a application resource.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "applicationResourceName": "sampleApplication", - "applicationResourceDescription": { - "properties": { - "description": "Service Fabric Mesh sample 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 - } - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "endpointRefs": [ - { - "name": "helloWorldListener" - } - ] - } - ], - "replicaCount": 1 - } - } - ] - }, - "tags": {}, - "location": "EastUS" - } - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", - "name": "sampleApplication", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample application.", - "serviceNames": [ - "helloWorldService" - ], - "healthState": "Ok", - "status": "Ready" - } - } - }, - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", - "name": "sampleApplication", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "Service Fabric Mesh sample application.", - "serviceNames": [ - "helloWorldService" - ], - "healthState": "Unknown", - "status": "Creating" - } - } - }, - "202": {} - } +{ + "operationId": "Application_Create", + "description": "This example shows how to create or update a application resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication", + "applicationResourceDescription": { + "properties": { + "description": "Service Fabric Mesh sample 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 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaCount": 1 + } + } + ] + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Ok", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Unknown", + "status": "Creating" + } + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json index 205e16efce73..46ea5b8772d7 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json @@ -1,15 +1,15 @@ -{ - "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": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "applicationResourceName": "sampleApplication" - }, - "responses": { - "200": {}, - "202": {}, - "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": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json index 2f9a5185acb8..f77465d92d24 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json @@ -1,30 +1,30 @@ -{ - "operationId": "Application_Get", - "description": "This example shows how to get a application resource. If the application resource exists, its description is returned along with an OK (200) status code. If the application resource does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "applicationResourceName": "sampleApplication" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", - "name": "sampleApplication", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample application.", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - } - } - } +{ + "operationId": "Application_Get", + "description": "This example shows how to get a application resource. If the application resource exists, its description is returned along with an OK (200) status code. If the application resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json index 2e50bf4aa84d..f9fbcdf4dfb4 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json @@ -1,33 +1,33 @@ -{ - "operationId": "Application_ListByResourceGroup", - "description": "This example shows how to list all application resources within a specified resource group.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", - "name": "sampleApplication", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample application.", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Application_ListByResourceGroup", + "description": "This example shows how to list all application resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json index a56a76d0ff46..35641a7abda2 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json @@ -1,32 +1,32 @@ -{ - "operationId": "Application_ListBySubscriptionId", - "description": "This example shows how to list all application resources for a specified subscription.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/applications", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", - "name": "sampleApplication", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample application.", - "healthState": "Ok", - "serviceNames": [ - "helloWorldService" - ], - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Application_ListBySubscriptionId", + "description": "This example shows how to list all application resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json index cfa074561a1a..3bce4656e1cf 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json @@ -1,55 +1,55 @@ -{ - "operationId": "Service_Get", - "description": "This example shows how to get a service resource for a given application. If the service resource exists, its description is returned along with an OK (200) status code. If the service resource does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "applicationResourceName": "sampleApplication", - "serviceResourceName": "helloWorldService" - }, - "responses": { - "200": { - "body": { - "name": "helloWorldService", - "type": "Microsoft.ServiceFabricMesh/services", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication/services/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 - } - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "endpointRefs": [ - { - "name": "helloWorldListener" - } - ] - } - ], - "replicaCount": 1, - "healthState": "Ok", - "status": "Ready" - } - } - } - } +{ + "operationId": "Service_Get", + "description": "This example shows how to get a service resource for a given application. If the service resource exists, its description is returned along with an OK (200) status code. If the service resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication", + "serviceResourceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication/services/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 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaCount": 1, + "healthState": "Ok", + "status": "Ready" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json index 817b3a17f087..5ed68640fcec 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json @@ -1,58 +1,58 @@ -{ - "operationId": "Service_List", - "description": "This example shows how to list all services of a given application.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "applicationResourceName": "sampleApplication" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "helloWorldService", - "type": "Microsoft.ServiceFabricMesh/services", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication/services/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 - } - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "endpointRefs": [ - { - "name": "helloWorldListener" - } - ] - } - ], - "replicaCount": 1, - "healthState": "Ok", - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Service_List", + "description": "This example shows how to list all services of a given application.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication/services/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 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaCount": 1, + "healthState": "Ok", + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json index 252b978ba6a0..9d53a1b7d94b 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json @@ -1,20 +1,20 @@ -{ - "operationId": "CodePackage_GetContainerLogs", - "description": "This example shows how to get logs from the container of service replica. If the container exists, the logs are returned with an OK (200) status code, otherwise an error is returned with an appropriate status code.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "6.4-preview", - "applicationResourceName": "sbzDocApp", - "serviceResourceName": "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" - } - } - } -} +{ + "operationId": "CodePackage_GetContainerLogs", + "description": "This example shows how to get logs from the container of service replica. If the container exists, the logs are returned with an OK (200) status code, otherwise an error is returned with an appropriate status code.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "6.4-preview", + "applicationResourceName": "sbzDocApp", + "serviceResourceName": "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-09-01-preview/examples/applications/services/replicas/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/get.json index 7389c169983e..48eab2177d7e 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/get.json @@ -1,77 +1,77 @@ -{ - "operationId": "ServiceReplica_Get", - "description": "This example shows how to get information about given replica of a service. If the replica exists, its description is returned along with an OK (200) status code. If the replica does not exist, an error is returned with an appropriate status code.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-09-01-privatepreview", - "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" - }, - "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" - } - ] - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "endpointRefs": [ - { - "name": "helloWorldListener" - } - ] - } - ], - "replicaName": "0" - } - } - } +{ + "operationId": "ServiceReplica_Get", + "description": "This example shows how to get information about given replica of a service. If the replica exists, its description is returned along with an OK (200) status code. If the replica does not exist, an error is returned with an appropriate status code.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-09-01-privatepreview", + "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" + }, + "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" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaName": "0" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json index 50148c55f025..01e400bedc14 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json @@ -1,80 +1,80 @@ -{ - "operationId": "ServiceReplica_List", - "description": "This example shows how to list replicas of a service resources for a given application.", - "parameters": { - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "api-version": "2018-09-01-privatepreview", - "applicationResourceName": "sampleApplication", - "serviceResourceName": "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" - } - ] - } - } - ], - "networkRefs": [ - { - "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "endpointRefs": [ - { - "name": "helloWorldListener" - } - ] - } - ], - "replicaName": "0" - } - ] - } - } - } +{ + "operationId": "ServiceReplica_List", + "description": "This example shows how to list replicas of a service resources for a given application.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-09-01-privatepreview", + "applicationResourceName": "sampleApplication", + "serviceResourceName": "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" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaName": "0" + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json index f623636e7819..676e25cab1a7 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json @@ -1,205 +1,205 @@ -{ - "operationId": "Gateway_Create", - "description": "This example shows how to create or update a gateway resource.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "gatewayResourceName": "sampleGateway", - "gatewayResourceDescription": { - "properties": { - "description": "Service Fabric Mesh sample gateway.", - "sourceNetwork": { - "name": "Open" - }, - "destinationNetwork": { - "name": "helloWorldNetwork" - }, - "tcp": [ - { - "name": "web", - "port": 80, - "destination": { - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - } - ], - "http": [ - { - "name": "contosoWebsite", - "port": 8081, - "hosts": [ - { - "name": "contoso.com", - "routes": [ - { - "name": "index", - "match": { - "path": { - "value": "/index", - "rewrite": "/", - "type": "prefix" - }, - "headers": [ - { - "name": "accept", - "value": "application/json", - "type": "exact" - } - ] - }, - "destination": { - "applicationName": "httpHelloWorldApp", - "serviceName": "indexService", - "endpointName": "indexHttpEndpoint" - } - } - ] - } - ] - } - ] - }, - "tags": {}, - "location": "EastUS" - } - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/gateways", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", - "name": "sampleGateway", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample gateway.", - "sourceNetwork": { - "name": "Open" - }, - "destinationNetwork": { - "name": "helloWorldNetwork" - }, - "tcp": [ - { - "name": "web", - "port": 80, - "destination": { - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - } - ], - "http": [ - { - "name": "contosoWebsite", - "port": 8081, - "hosts": [ - { - "name": "contoso.com", - "routes": [ - { - "name": "index", - "match": { - "path": { - "value": "/index", - "rewrite": "/", - "type": "prefix" - }, - "headers": [ - { - "name": "accept", - "value": "application/json", - "type": "exact" - } - ] - }, - "destination": { - "applicationName": "httpHelloWorldApp", - "serviceName": "indexService", - "endpointName": "indexHttpEndpoint" - } - } - ] - } - ] - } - ], - "ipAddress": "192.168.1.1", - "status": "Ready" - } - } - }, - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/gateways", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", - "name": "sampleGateway", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "Service Fabric Mesh sample gateway.", - "sourceNetwork": { - "name": "Open" - }, - "destinationNetwork": { - "name": "helloWorldNetwork" - }, - "tcp": [ - { - "name": "web", - "port": 80, - "destination": { - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - } - ], - "http": [ - { - "name": "contosoWebsite", - "port": 8081, - "hosts": [ - { - "name": "contoso.com", - "routes": [ - { - "name": "index", - "match": { - "path": { - "value": "/index", - "rewrite": "/", - "type": "prefix" - }, - "headers": [ - { - "name": "accept", - "value": "application/json", - "type": "exact" - } - ] - }, - "destination": { - "applicationName": "httpHelloWorldApp", - "serviceName": "indexService", - "endpointName": "indexHttpEndpoint" - } - } - ] - } - ] - } - ], - "status": "Creating" - } - } - }, - "202": {} - } +{ + "operationId": "Gateway_Create", + "description": "This example shows how to create or update a gateway resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "gatewayResourceName": "sampleGateway", + "gatewayResourceDescription": { + "properties": { + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ] + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "status": "Creating" + } + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json index f5b6f1ddb8b7..5a34eb59eb41 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json @@ -1,15 +1,15 @@ -{ - "operationId": "Gateway_Delete", - "description": "This example shows how to delete an existing gateway resource. If the gateway resource exists and is deleted successfully, an empty response with 200 status code is returned. If the gateway resource does not exist, an empty response with 204 status code is returned.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "gatewayResourceName": "sampleGateway" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } +{ + "operationId": "Gateway_Delete", + "description": "This example shows how to delete an existing gateway resource. If the gateway resource exists and is deleted successfully, an empty response with 200 status code is returned. If the gateway resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "gatewayResourceName": "sampleGateway" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json index 64d47ec975df..c2c1eccd8a40 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json @@ -1,79 +1,79 @@ -{ - "operationId": "Gateway_Get", - "description": "This example shows how to get a gateway resource. If the gateway resource exists, its description is returned along with an OK (200) status code. If the gateway resource does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "gatewayResourceName": "sampleGateway" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/gateways", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", - "name": "sampleGateway", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample gateway.", - "sourceNetwork": { - "name": "Open" - }, - "destinationNetwork": { - "name": "helloWorldNetwork" - }, - "tcp": [ - { - "name": "web", - "port": 80, - "destination": { - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - } - ], - "http": [ - { - "name": "contosoWebsite", - "port": 8081, - "hosts": [ - { - "name": "contoso.com", - "routes": [ - { - "name": "index", - "match": { - "path": { - "value": "/index", - "rewrite": "/", - "type": "prefix" - }, - "headers": [ - { - "name": "accept", - "value": "application/json", - "type": "exact" - } - ] - }, - "destination": { - "applicationName": "httpHelloWorldApp", - "serviceName": "indexService", - "endpointName": "indexHttpEndpoint" - } - } - ] - } - ] - } - ], - "ipAddress": "192.168.1.1", - "status": "Ready" - } - } - } - } +{ + "operationId": "Gateway_Get", + "description": "This example shows how to get a gateway resource. If the gateway resource exists, its description is returned along with an OK (200) status code. If the gateway resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "gatewayResourceName": "sampleGateway" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json index daab5de4a032..51f751f14017 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json @@ -1,82 +1,82 @@ -{ - "operationId": "Gateway_ListByResourceGroup", - "description": "This example shows how to list all gateway resources within a specified resource group.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/gateways", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", - "name": "sampleGateway", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample gateway.", - "sourceNetwork": { - "name": "Open" - }, - "destinationNetwork": { - "name": "helloWorldNetwork" - }, - "tcp": [ - { - "name": "web", - "port": 80, - "destination": { - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - } - ], - "http": [ - { - "name": "contosoWebsite", - "port": 8081, - "hosts": [ - { - "name": "contoso.com", - "routes": [ - { - "name": "index", - "match": { - "path": { - "value": "/index", - "rewrite": "/", - "type": "prefix" - }, - "headers": [ - { - "name": "accept", - "value": "application/json", - "type": "exact" - } - ] - }, - "destination": { - "applicationName": "httpHelloWorldApp", - "serviceName": "indexService", - "endpointName": "indexHttpEndpoint" - } - } - ] - } - ] - } - ], - "ipAddress": "192.168.1.1", - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Gateway_ListByResourceGroup", + "description": "This example shows how to list all gateway resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json index 350701ab1b44..c0eaee7ad713 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json @@ -1,81 +1,81 @@ -{ - "operationId": "Gateway_ListBySubscriptionId", - "description": "This example shows how to list all gateway resources for a specified subscription.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/gateways", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", - "name": "sampleGateway", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample gateway.", - "sourceNetwork": { - "name": "Open" - }, - "destinationNetwork": { - "name": "helloWorldNetwork" - }, - "tcp": [ - { - "name": "web", - "port": 80, - "destination": { - "applicationName": "helloWorldApp", - "serviceName": "helloWorldService", - "endpointName": "helloWorldListener" - } - } - ], - "http": [ - { - "name": "contosoWebsite", - "port": 8081, - "hosts": [ - { - "name": "contoso.com", - "routes": [ - { - "name": "index", - "match": { - "path": { - "value": "/index", - "rewrite": "/", - "type": "prefix" - }, - "headers": [ - { - "name": "accept", - "value": "application/json", - "type": "exact" - } - ] - }, - "destination": { - "applicationName": "httpHelloWorldApp", - "serviceName": "indexService", - "endpointName": "indexHttpEndpoint" - } - } - ] - } - ] - } - ], - "ipAddress": "192.168.1.1", - "status": "Ready" - } - } - ] - } - } - } -} +{ + "operationId": "Gateway_ListBySubscriptionId", + "description": "This example shows how to list all gateway resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json index 48b660c8af57..ba69f964b944 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json @@ -1,54 +1,54 @@ -{ - "operationId": "Network_Create", - "description": "This example shows how to create or update a network resource.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "networkResourceName": "sampleNetwork", - "networkResourceDescription": { - "properties": { - "kind": "Local", - "description": "Service Fabric Mesh sample network.", - "networkAddressPrefix": "2.0.0.0/16" - }, - "tags": {}, - "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/sampleNetwork", - "name": "sampleNetwork", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "Local", - "description": "Service Fabric Mesh sample network.", - "networkAddressPrefix": "2.0.0.0/16", - "status": "Ready" - } - } - }, - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "name": "sampleNetwork", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "kind": "Local", - "description": "Service Fabric Mesh sample network.", - "networkAddressPrefix": "2.0.0.0/16", - "status": "Creating" - } - } - }, - "202": {} - } +{ + "operationId": "Network_Create", + "description": "This example shows how to create or update a network resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "networkResourceName": "sampleNetwork", + "networkResourceDescription": { + "properties": { + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16" + }, + "tags": {}, + "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/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Creating" + } + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json index cd3c9786f256..7b9d67c99a7b 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json @@ -1,15 +1,15 @@ -{ - "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 exist, an empty response with 204 status code is returned.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "networkResourceName": "sampleNetwork" - }, - "responses": { - "200": {}, - "202": {}, - "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 exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "networkResourceName": "sampleNetwork" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json index e8704f6ac183..5ce76e4460a0 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json @@ -1,28 +1,28 @@ -{ - "operationId": "Network_Get", - "description": "This example shows how to get a network resource. If the network resource exists, its description is returned along with an OK (200) status code. If the network resource does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "networkResourceName": "sampleNetwork" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "name": "sampleNetwork", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "Local", - "description": "Service Fabric Mesh sample network.", - "networkAddressPrefix": "2.0.0.0/16", - "status": "Ready" - } - } - } - } +{ + "operationId": "Network_Get", + "description": "This example shows how to get a network resource. If the network resource exists, its description is returned along with an OK (200) status code. If the network resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "networkResourceName": "sampleNetwork" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json index 616292b2b942..02e02e71c87d 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json @@ -1,31 +1,31 @@ -{ - "operationId": "Network_ListByResourceGroup", - "description": "This example shows how to list all network resources within a specified resource group.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "name": "sampleNetwork", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "Local", - "description": "Service Fabric Mesh sample network.", - "networkAddressPrefix": "2.0.0.0/16", - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Network_ListByResourceGroup", + "description": "This example shows how to list all network resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json index 88ee368b5fcf..ab5f8421f290 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json @@ -1,30 +1,30 @@ -{ - "operationId": "Network_ListBySubscriptionId", - "description": "This example shows how to list all network resources for a specified subscription.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/networks", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", - "name": "sampleNetwork", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "Local", - "description": "Service Fabric Mesh sample network.", - "networkAddressPrefix": "2.0.0.0/16", - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Network_ListBySubscriptionId", + "description": "This example shows how to list all network resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json index c3525487a294..40c3ac11fe74 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json @@ -1,54 +1,54 @@ -{ - "operationId": "Secret_Create", - "description": "This example shows how to create or update a secret resource.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString", - "secretResourceDescription": { - "properties": { - "kind": "inlinedValue", - "contentType": "text/plain", - "description": "Mongo DB connection string for backend database!" - }, - "tags": {}, - "location": "EastUS" - } - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/secrets", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", - "name": "dbConnectionString", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "inlinedValue", - "contentType": "text/plain", - "description": "Mongo DB connection string for backend database!", - "status": "Ready" - } - } - }, - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/secrets", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", - "name": "dbConnectionString", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "kind": "inlinedValue", - "contentType": "text/plain", - "description": "Mongo DB connection string for backend database!", - "status": "Creating" - } - } - }, - "202": {} - } +{ + "operationId": "Secret_Create", + "description": "This example shows how to create or update a secret resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretResourceDescription": { + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!" + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Creating" + } + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json index a89e0f733d00..0788afd7ab2c 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json @@ -1,15 +1,15 @@ -{ - "operationId": "Secret_Delete", - "description": "This example shows how to delete an existing secret resource. If the secret resource exists and is deleted successfully, an empty response with 200 status code is returned. If the secret resource does not exit, an empty response with 204 status code is returned.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} +{ + "operationId": "Secret_Delete", + "description": "This example shows how to delete an existing secret resource. If the secret resource exists and is deleted successfully, an empty response with 200 status code is returned. If the secret resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json index e76e9a529def..f9f50d67158a 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json @@ -1,28 +1,28 @@ -{ - "operationId": "Secret_Get", - "description": "This example shows how to get a secret resource. If the secret resource exists, its description is returned along with an OK (200) status code. If the secret resource does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/secrets", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", - "name": "dbConnectionString", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "inlinedValue", - "contentType": "text/plain", - "description": "Mongo DB connection string for backend database!", - "status": "Ready" - } - } - } - } +{ + "operationId": "Secret_Get", + "description": "This example shows how to get a secret resource. If the secret resource exists, its description is returned along with an OK (200) status code. If the secret resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json index 65461234ce69..305fb6cc2519 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json @@ -1,31 +1,31 @@ -{ - "operationId": "Secret_ListByResourceGroup", - "description": "This example shows how to list all secret resources within a specified resource group.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/secrets", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", - "name": "dbConnectionString", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "inlinedValue", - "contentType": "text/plain", - "description": "Mongo DB connection string for backend database!", - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Secret_ListByResourceGroup", + "description": "This example shows how to list all secret resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json index 428077057c95..73064905e3f8 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json @@ -1,30 +1,30 @@ -{ - "operationId": "Secret_ListBySubscriptionId", - "description": "This example shows how to list all secret resources for a specified subscription.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/secrets", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", - "name": "dbConnectionString", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "kind": "inlinedValue", - "contentType": "text/plain", - "description": "Mongo DB connection string for backend database!", - "status": "Ready" - } - } - ] - } - } - } +{ + "operationId": "Secret_ListBySubscriptionId", + "description": "This example shows how to list all secret resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json index a6f5a1c433b8..b4821b8cb84d 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json @@ -1,44 +1,44 @@ -{ - "operationId": "SecretValue_Create", - "description": "This example shows how to add a new value of a secret resource; the secret value is provided as plaintext.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString", - "secretValueResourceName": "v1", - "secretValueResourceDescription": { - "name": "v1", - "properties": { - "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" - } - } - }, - "responses": { - "200": { - "body": { - "type": "secrets/values", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", - "name": "v1", - "properties": { - "provisioningState": "Succeeded", - "value": null - } - } - }, - "201": { - "body": { - "type": "secrets/values", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", - "name": "v1", - "properties": { - "provisioningState": "Updating", - "value": null - } - } - }, - "202": {} - } +{ + "operationId": "SecretValue_Create", + "description": "This example shows how to add a new value of a secret resource; the secret value is provided as plaintext.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1", + "secretValueResourceDescription": { + "name": "v1", + "properties": { + "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" + } + } + }, + "responses": { + "200": { + "body": { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + } + }, + "201": { + "body": { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Updating", + "value": null + } + } + }, + "202": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json index 73049985da4f..9f4932be62f1 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json @@ -1,16 +1,16 @@ -{ - "operationId": "SecretValue_Delete", - "description": "This example shows how to delete a secret value. If the specified named value exists and is deleted successfully, an empty response with 200 status code is returned. If the specified named value does not exist, an empty response with 204 status code is returned.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString", - "secretValueResourceName": "v1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } +{ + "operationId": "SecretValue_Delete", + "description": "This example shows how to delete a secret value. If the specified named value exists and is deleted successfully, an empty response with 200 status code is returned. If the specified named value does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json index 21c1c187b1a0..5b7becbf76b0 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json @@ -1,25 +1,25 @@ -{ - "operationId": "SecretValue_Get", - "description": "This example shows how to get the specified secret value resource. If the specified named value exists, its information is returned along with status code 200. The information does not include the value. To get the unecnrypted value use SecretValue_ListValue operation. If the specified named value does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString", - "secretValueResourceName": "v1" - }, - "responses": { - "200": { - "body": { - "type": "secrets/values", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", - "name": "v1", - "properties": { - "provisioningState": "Succeeded", - "value": null - } - } - } - } +{ + "operationId": "SecretValue_Get", + "description": "This example shows how to get the specified secret value resource. If the specified named value exists, its information is returned along with status code 200. The information does not include the value. To get the unecnrypted value use SecretValue_ListValue operation. If the specified named value does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": { + "body": { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json index e1c83162d8a7..905890b8a9b3 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json @@ -1,38 +1,38 @@ -{ - "operationId": "SecretValue_List", - "description": "This example shows how to list names of all values of a secret resource, not including their respective values.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "secrets/values", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", - "name": "v1", - "properties": { - "provisioningState": "Succeeded", - "value": null - } - }, - { - "type": "secrets/values", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v2", - "name": "v2", - "properties": { - "provisioningState": "Succeeded", - "value": null - } - } - ] - } - } - } +{ + "operationId": "SecretValue_List", + "description": "This example shows how to list names of all values of a secret resource, not including their respective values.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + }, + { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v2", + "name": "v2", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json index df2530b182cd..f341e143f0b1 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json @@ -1,18 +1,18 @@ -{ - "operationId": "SecretValue_ListValue", - "description": "This example shows how to get the unencrypted value of the secret. If the specified named value resource exists, its unencrypted value is returned along with status code 200. If the specified named value does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "secretResourceName": "dbConnectionString", - "secretValueResourceName": "v1" - }, - "responses": { - "200": { - "body": { - "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" - } - } - } +{ + "operationId": "SecretValue_ListValue", + "description": "This example shows how to get the unencrypted value of the secret. If the specified named value resource exists, its unencrypted value is returned along with status code 200. If the specified named value does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": { + "body": { + "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" + } + } + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json index 26eae959a25f..591d621602d9 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json @@ -1,64 +1,64 @@ -{ - "operationId": "Volume_Create", - "description": "This example shows how to create or update a volume resource.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "volumeResourceName": "sampleVolume", - "volumeResourceDescription": { - "properties": { - "description": "Service Fabric Mesh sample volume.", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "accountKey": "provide-account-key-here", - "shareName": "sharel" - }, - "provider": "SFAzureFile" - }, - "tags": {}, - "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/sampleVolume", - "name": "sampleVolume", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample volume.", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "shareName": "sharel" - }, - "provider": "SFAzureFile", - "status": "Ready" - } - } - }, - "201": { - "body": { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", - "name": "sampleVolume", - "tags": {}, - "properties": { - "provisioningState": "Updating", - "description": "Service Fabric Mesh sample volume.", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "shareName": "sharel" - }, - "provider": "SFAzureFile", - "status": "Creating" - } - } - }, - "202": {} - } -} +{ + "operationId": "Volume_Create", + "description": "This example shows how to create or update a volume resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "volumeResourceName": "sampleVolume", + "volumeResourceDescription": { + "properties": { + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": "provide-account-key-here", + "shareName": "sharel" + }, + "provider": "SFAzureFile" + }, + "tags": {}, + "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/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json index f4cee9a52f41..7e3f7f4d7c59 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json @@ -1,15 +1,15 @@ -{ - "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": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "volumeResourceName": "sampleVolume" - }, - "responses": { - "200": {}, - "202": {}, - "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": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "volumeResourceName": "sampleVolume" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } } \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json index fd4da47a9a43..fb3a69c9d84b 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json @@ -1,31 +1,31 @@ -{ - "operationId": "Volume_Get", - "description": "This example shows how to get a volume resource. If the volume resource exists, its description is returned along with an OK (200) status code. If the volume resource does not exist, an error is returned with an appropriate status code.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo", - "volumeResourceName": "sampleVolume" - }, - "responses": { - "200": { - "body": { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", - "name": "sampleVolume", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample volume.", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "shareName": "sharel" - }, - "provider": "SFAzureFile", - "status": "Ready" - } - } - } - } -} +{ + "operationId": "Volume_Get", + "description": "This example shows how to get a volume resource. If the volume resource exists, its description is returned along with an OK (200) status code. If the volume resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "volumeResourceName": "sampleVolume" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json index 2377230e774a..e6ac3143e417 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json @@ -1,34 +1,34 @@ -{ - "operationId": "Volume_ListByResourceGroup", - "description": "This example shows how to list all volume resources within a specified resource group.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "sbz_demo" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", - "name": "sampleVolume", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample volume.", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "shareName": "sharel" - }, - "provider": "SFAzureFile", - "status": "Ready" - } - } - ] - } - } - } -} +{ + "operationId": "Volume_ListByResourceGroup", + "description": "This example shows how to list all volume resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json index bc4c893d9def..aa7e94bf8175 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json @@ -1,33 +1,33 @@ -{ - "operationId": "Volume_ListBySubscriptionId", - "description": "This example shows how to list all volume resources for a specified subscription.", - "parameters": { - "api-version": "2018-09-01-privatepreview", - "subscriptionId": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "type": "Microsoft.ServiceFabricMesh/volumes", - "location": "EastUS", - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", - "name": "sampleVolume", - "tags": {}, - "properties": { - "provisioningState": "Succeeded", - "description": "Service Fabric Mesh sample volume.", - "azureFileParameters": { - "accountName": "sbzdemoaccount", - "shareName": "sharel" - }, - "provider": "SFAzureFile", - "status": "Ready" - } - } - ] - } - } - } -} +{ + "operationId": "Volume_ListBySubscriptionId", + "description": "This example shows how to list all volume resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json index dee8fb7b1d56..48ae0d6e78c5 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json @@ -1,3954 +1,3954 @@ -{ - "swagger": "2.0", - "info": { - "title": "SeaBreezeManagementClient", - "description": "APIs to deploy and manage resources to SeaBreeze.", - "version": "2018-09-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.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/secrets/{secretResourceName}": { - "put": { - "operationId": "Secret_Create", - "x-ms-examples": { - "CreateOrUpdateSecret": { - "$ref": "./examples/secrets/create_update.json" - } - }, - "summary": "Creates or updates a secret resource.", - "description": "Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Secrets" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/SecretResourceDescription" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-sf-codegen": { - "Powershell": { - "skipGeneration": "true" - } - } - }, - "get": { - "operationId": "Secret_Get", - "x-ms-examples": { - "GetSecret": { - "$ref": "./examples/secrets/get.json" - } - }, - "summary": "Gets the secret resource with the given name.", - "description": "Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - } - ], - "tags": [ - "Secrets" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Secret_Delete", - "x-ms-examples": { - "DeleteSecret": { - "$ref": "./examples/secrets/delete.json" - } - }, - "summary": "Deletes the secret resource.", - "description": "Deletes the secret resource identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - } - ], - "tags": [ - "Secrets" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content - the specified secret was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets": { - "get": { - "operationId": "Secret_ListByResourceGroup", - "x-ms-examples": { - "ListSecretsByResourceGroup": { - "$ref": "./examples/secrets/list_byResourceGroup.json" - } - }, - "summary": "Gets all the secret resources in a given resource group.", - "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - } - ], - "tags": [ - "Secrets" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/secrets": { - "get": { - "operationId": "Secret_ListBySubscription", - "x-ms-examples": { - "ListSecretsBySubscriptionId": { - "$ref": "./examples/secrets/list_bySubscriptionId.json" - } - }, - "summary": "Gets all the secret resources in a given subscription.", - "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - } - ], - "tags": [ - "Secrets" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}": { - "put": { - "operationId": "SecretValue_Create", - "x-ms-examples": { - "CreateSecretValue": { - "$ref": "./examples/secrets/values/create.json" - } - }, - "summary": "Adds the specified value as a new version of the specified secret resource.", - "description": "Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretValueResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "SecretValues" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretValueResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/SecretValueResourceDescription" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-sf-codegen": { - "Powershell": { - "skipGeneration": "true" - } - } - }, - "get": { - "operationId": "SecretValue_Get", - "x-ms-examples": { - "GetSecretValue": { - "$ref": "./examples/secrets/values/get.json" - } - }, - "summary": "Gets the specified secret value resource.", - "description": "Get the information about the specified named secret value resources. The information does not include the actual value of the secret.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" - } - ], - "tags": [ - "SecretValues" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretValueResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "SecretValue_Delete", - "x-ms-examples": { - "DeleteSecretValue": { - "$ref": "./examples/secrets/values/delete.json" - } - }, - "summary": "Deletes the specified value of the named secret resource.", - "description": "Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" - } - ], - "tags": [ - "SecretValues" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content - the specified named secret value was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values": { - "get": { - "operationId": "SecretValue_List", - "x-ms-examples": { - "ListSecretValues": { - "$ref": "./examples/secrets/values/list.json" - } - }, - "summary": "List names of all values of the specified secret resource.", - "description": "Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - } - ], - "tags": [ - "SecretValues" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretValueResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}/list_value": { - "post": { - "operationId": "SecretValue_ListValue", - "x-ms-examples": { - "ListSecretValue": { - "$ref": "./examples/secrets/values/list_value.json" - } - }, - "summary": "Lists the specified value of the secret resource.", - "description": "Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" - } - ], - "tags": [ - "SecretValues" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SecretValue" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}": { - "put": { - "operationId": "Volume_Create", - "x-ms-examples": { - "CreateOrUpdateVolume": { - "$ref": "./examples/volumes/create_update.json" - } - }, - "summary": "Creates or updates a volume resource.", - "description": "Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-sf-codegen": { - "Powershell": { - "skipGeneration": "true" - } - } - }, - "get": { - "operationId": "Volume_Get", - "x-ms-examples": { - "GetVolume": { - "$ref": "./examples/volumes/get.json" - } - }, - "summary": "Gets the volume resource with the given name.", - "description": "Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Volume_Delete", - "x-ms-examples": { - "DeleteVolume": { - "$ref": "./examples/volumes/delete.json" - } - }, - "summary": "Deletes the volume resource.", - "description": "Deletes the volume resource identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" - } - ], - "tags": [ - "Volumes" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "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": { - "ListVolumesByResourceGroup": { - "$ref": "./examples/volumes/list_byResourceGroup.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 include the description and other properties of the Volume.", - "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": { - "ListVolumesBySubscriptionId": { - "$ref": "./examples/volumes/list_bySubscriptionId.json" - } - }, - "summary": "Gets all the volume resources in a given subscription.", - "description": "Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.", - "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" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}": { - "put": { - "operationId": "Network_Create", - "x-ms-examples": { - "CreateOrUpdateNetwork": { - "$ref": "./examples/networks/create_update.json" - } - }, - "summary": "Creates or updates a network resource.", - "description": "Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-sf-codegen": { - "Powershell": { - "skipGeneration": "true" - } - } - }, - "get": { - "operationId": "Network_Get", - "x-ms-examples": { - "GetNetwork": { - "$ref": "./examples/networks/get.json" - } - }, - "summary": "Gets the network resource with the given name.", - "description": "Gets the information about the network resource with the given name. The information include the description and other properties of the network.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Network_Delete", - "x-ms-examples": { - "DeleteNetwork": { - "$ref": "./examples/networks/delete.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/NetworkResourceNameRequiredPathParam" - } - ], - "tags": [ - "Networks" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "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": { - "ListNetworksByResourceGroup": { - "$ref": "./examples/networks/list_byResourceGroup.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 include the description and other properties of the Network.", - "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": { - "ListNetworksBySubscriptionId": { - "$ref": "./examples/networks/list_bySubscriptionId.json" - } - }, - "summary": "Gets all the network resources in a given subscription.", - "description": "Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.", - "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/gateways/{gatewayResourceName}": { - "put": { - "operationId": "Gateway_Create", - "x-ms-examples": { - "CreateOrUpdateGateway": { - "$ref": "./examples/gateways/create_update.json" - } - }, - "summary": "Creates or updates a gateway resource.", - "description": "Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/GatewayResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Gateways" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GatewayResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/GatewayResourceDescription" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-sf-codegen": { - "Powershell": { - "skipGeneration": "true" - } - } - }, - "get": { - "operationId": "Gateway_Get", - "x-ms-examples": { - "GetGateway": { - "$ref": "./examples/gateways/get.json" - } - }, - "summary": "Gets the gateway resource with the given name.", - "description": "Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" - } - ], - "tags": [ - "Gateways" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GatewayResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Gateway_Delete", - "x-ms-examples": { - "DeleteGateway": { - "$ref": "./examples/gateways/delete.json" - } - }, - "summary": "Deletes the gateway resource.", - "description": "Deletes the gateway resource identified by the name.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" - } - ], - "tags": [ - "Gateways" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content - the specified gateway was not found." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways": { - "get": { - "operationId": "Gateway_ListByResourceGroup", - "x-ms-examples": { - "ListGatewaysByResourceGroup": { - "$ref": "./examples/gateways/list_byResourceGroup.json" - } - }, - "summary": "Gets all the gateway resources in a given resource group.", - "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - } - ], - "tags": [ - "Gateways" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GatewayResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/gateways": { - "get": { - "operationId": "Gateway_ListBySubscription", - "x-ms-examples": { - "ListGatewaysBySubscriptionId": { - "$ref": "./examples/gateways/list_bySubscriptionId.json" - } - }, - "summary": "Gets all the gateway resources in a given subscription.", - "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - } - ], - "tags": [ - "Gateways" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/GatewayResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}": { - "put": { - "operationId": "Application_Create", - "x-ms-examples": { - "CreateOrUpdateApplication": { - "$ref": "./examples/applications/create_update.json" - } - }, - "summary": "Creates or updates an application resource.", - "description": "Creates an application resource with the specified name, description and properties. If an application resource with the same name exists, then it is updated with the specified description and properties.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-sf-codegen": { - "Powershell": { - "skipGeneration": "true" - } - } - }, - "get": { - "operationId": "Application_Get", - "x-ms-examples": { - "GetApplication": { - "$ref": "./examples/applications/get.json" - } - }, - "summary": "Gets the application resource with the given name.", - "description": "Gets the information about the application resource with the given name. The information include the description and other properties of the application.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - }, - "delete": { - "operationId": "Application_Delete", - "x-ms-examples": { - "DeleteApplication": { - "$ref": "./examples/applications/delete.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/ApplicationResourceNameRequiredPathParam" - } - ], - "tags": [ - "Applications" - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "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": { - "get": { - "operationId": "Application_ListByResourceGroup", - "x-ms-examples": { - "ListApplicationsByResourceGroup": { - "$ref": "./examples/applications/list_byResourceGroup.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 include the description and other properties of the Application.", - "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": { - "ListApplicationsBySubscriptionId": { - "$ref": "./examples/applications/list_bySubscriptionId.json" - } - }, - "summary": "Gets all the application resources in a given subscription.", - "description": "Gets the information about all application resources in a given resource group. The information include the description and other properties of the application.", - "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/{applicationResourceName}/services/{serviceResourceName}": { - "get": { - "operationId": "Service_Get", - "x-ms-examples": { - "GetService": { - "$ref": "./examples/applications/services/get.json" - } - }, - "summary": "Gets the service resource with the given name.", - "description": "Gets the information about the service resource with the given name. The information include the description and other properties of the service.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" - } - ], - "tags": [ - "Services" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResourceDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services": { - "get": { - "operationId": "Service_List", - "x-ms-examples": { - "ListServices": { - "$ref": "./examples/applications/services/list.json" - } - }, - "summary": "Lists all the service resources.", - "description": "Gets the information about all services of an application resource. The information include the description and other properties of the Service.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - } - ], - "tags": [ - "Services" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceResourceDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}": { - "get": { - "operationId": "ServiceReplica_Get", - "x-ms-examples": { - "ReplicaGet": { - "$ref": "./examples/applications/services/replicas/get.json" - } - }, - "summary": "Gets the given replica of the service of an application.", - "description": "Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaNameRequiredPathParam" - } - ], - "tags": [ - "ServiceReplicas" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceReplicaDescription" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas": { - "get": { - "operationId": "ServiceReplica_List", - "x-ms-examples": { - "ReplicasGetAll": { - "$ref": "./examples/applications/services/replicas/list.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/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" - } - ], - "tags": [ - "ServiceReplicas" - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServiceReplicaDescriptionList" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs": { - "get": { - "operationId": "CodePackage_GetContainerLogs", - "x-ms-examples": { - "GetContainerLogs": { - "$ref": "./examples/applications/services/replicas/codepackages/get_logs.json" - } - }, - "summary": "Gets the logs from the container.", - "description": "Gets the logs for the container of the specified code package of the service replica.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionIdRequiredPathParam" - }, - { - "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" - }, - { - "$ref": "#/parameters/api-versionRequiredQueryParam" - }, - { - "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" - }, - { - "$ref": "#/parameters/ReplicaNameRequiredPathParam" - }, - { - "$ref": "#/parameters/CodePackageNameRequiredPathParam" - }, - { - "$ref": "#/parameters/TailOptionalQueryParam" - } - ], - "tags": [ - "CodePackages" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/ContainerLogs" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/ErrorModel" - } - } - } - } - } - }, - "definitions": { - "ResourceStatus": { - "description": "Status of the resource.", - "type": "string", - "enum": [ - "Unknown", - "Ready", - "Upgrading", - "Creating", - "Deleting", - "Failed" - ], - "x-ms-enum": { - "name": "ResourceStatus", - "modelAsString": true, - "values": [ - { - "value": "Unknown", - "description": "Indicates the resource status is unknown. The value is zero." - }, - { - "value": "Ready", - "description": "Indicates the resource is ready. The value is 1." - }, - { - "value": "Upgrading", - "description": "Indicates the resource is upgrading. The value is 2." - }, - { - "value": "Creating", - "description": "Indicates the resource is being created. The value is 3." - }, - { - "value": "Deleting", - "description": "Indicates the resource is being deleted. The value is 4." - }, - { - "value": "Failed", - "description": "Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5." - } - ] - } - }, - "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." - } - ] - } - }, - "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": { - "error": { - "$ref": "#/definitions/ErrorErrorModel", - "description": "Error model information" - } - }, - "description": "The error details.", - "required": [ - "error" - ] - }, - "ErrorErrorModel": { - "description": "Error model information", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string", - "description": "Error message." - }, - "innerError": { - "type": "string" - }, - "details": { - "type": "array", - "description": "List of error message details.", - "items": { - "$ref": "#/definitions/ErrorDetailsModel" - } - } - }, - "required": [ - "code" - ] - }, - "ErrorDetailsModel": { - "description": "Error model details information", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string", - "description": "Error message." - } - }, - "required": [ - "code", - "message" - ] - }, - "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." - }, - "ProvisionedResourceProperties": { - "description": "Describes common properties of a provisioned resource.", - "properties": { - "provisioningState": { - "type": "string", - "description": "State of the resource.", - "readOnly": 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 - }, - "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" - ] - } - }, - "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" - ] - }, - "SecretKind": { - "type": "string", - "description": "Describes the kind of secret.", - "enum": [ - "inlinedValue" - ], - "x-ms-enum": { - "name": "SecretKind", - "modelAsString": true, - "values": [ - { - "value": "inlinedValue", - "description": "A simple secret resource whose plaintext value is provided by the user." - } - ] - } - }, - "SecretResourceProperties": { - "description": "Describes the properties of a secret resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/SecretResourcePropertiesBase" - } - ], - "properties": { - "description": { - "description": "User readable description of the secret.", - "type": "string" - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ResourceStatus", - "description": "Status of the resource." - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the secret." - }, - "contentType": { - "type": "string", - "description": "The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed." - } - } - }, - "InlinedValueSecretResourceProperties": { - "description": "Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.", - "allOf": [ - { - "$ref": "#/definitions/SecretResourceProperties" - } - ], - "x-ms-discriminator-value": "inlinedValue" - }, - "SecretResourcePropertiesBase": { - "discriminator": "kind", - "description": "This type describes the properties of a secret resource, including its kind.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - } - ], - "properties": { - "kind": { - "$ref": "#/definitions/SecretKind", - "description": "Describes the kind of secret." - } - }, - "required": [ - "kind" - ] - }, - "SecretResourceDescription": { - "description": "This type describes a secret resource.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SecretResourceProperties", - "description": "Describes the properties of a secret resource." - } - }, - "required": [ - "properties" - ] - }, - "SecretResourceDescriptionList": { - "description": "A pageable list of secret resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SecretResourceDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "SecretValue": { - "type": "object", - "description": "This type represents the unencrypted value of the secret.", - "properties": { - "value": { - "type": "string", - "description": "The actual value of the secret." - } - } - }, - "SecretValueProperties": { - "type": "object", - "description": "This type describes properties of secret value resource.", - "properties": { - "value": { - "type": "string", - "description": "The actual value of the secret." - } - } - }, - "SecretValueResourceProperties": { - "description": "This type describes properties of a secret value resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/SecretValueProperties" - } - ] - }, - "SecretValueResourceDescription": { - "description": "This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SecretValueResourceProperties", - "description": "This type describes properties of a secret value resource." - } - }, - "required": [ - "properties" - ] - }, - "SecretValueResourceDescriptionList": { - "description": "A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unencrypted value.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/SecretValueResourceDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "VolumeProperties": { - "description": "Describes properties of a volume resource.", - "properties": { - "description": { - "type": "string", - "description": "User readable description of the volume." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ResourceStatus", - "description": "Status of the volume." - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the volume." - }, - "provider": { - "$ref": "#/definitions/VolumeProvider", - "description": "Provider of the volume." - }, - "azureFileParameters": { - "$ref": "#/definitions/VolumeProviderParametersAzureFile", - "description": "This type describes a volume provided by an Azure Files file share." - } - }, - "required": [ - "provider" - ] - }, - "VolumeProvider": { - "type": "string", - "description": "Describes the provider of the volume resource.", - "enum": [ - "SFAzureFile" - ], - "x-ms-enum": { - "name": "VolumeProvider", - "modelAsString": true, - "values": [ - { - "value": "SFAzureFile", - "description": "Provides volumes that are backed by Azure Files." - } - ] - } - }, - "VolumeProviderParametersAzureFile": { - "description": "This type describes a volume provided by an Azure Files file share.", - "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" - ] - }, - "VolumeReference": { - "description": "Describes a reference to a volume resource.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the volume being referenced." - }, - "readOnly": { - "type": "boolean", - "description": "The flag indicating whether the volume is read only. Default is 'false'." - }, - "destinationPath": { - "type": "string", - "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed." - } - }, - "required": [ - "name", - "destinationPath" - ] - }, - "ApplicationScopedVolume": { - "description": "Describes a volume whose lifetime is scoped to the application's lifetime.", - "allOf": [ - { - "$ref": "#/definitions/VolumeReference" - } - ], - "properties": { - "creationParameters": { - "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters", - "description": "Describes parameters for creating application-scoped volumes." - } - }, - "required": [ - "creationParameters" - ] - }, - "ApplicationScopedVolumeCreationParameters": { - "description": "Describes parameters for creating application-scoped volumes.", - "type": "object", - "discriminator": "kind", - "properties": { - "kind": { - "$ref": "#/definitions/ApplicationScopedVolumeKind", - "description": "Specifies the application-scoped volume kind." - }, - "description": { - "description": "User readable description of the volume.", - "type": "string" - } - }, - "required": [ - "kind" - ] - }, - "ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk": { - "description": "Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks", - "allOf": [ - { - "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters" - } - ], - "properties": { - "sizeDisk": { - "description": "Volume size", - "type": "string", - "enum": [ - "Small", - "Medium", - "Large" - ], - "x-ms-enum": { - "name": "SizeTypes", - "modelAsString": true - } - } - }, - "required": [ - "sizeDisk" - ], - "x-ms-discriminator-value": "ServiceFabricVolumeDisk" - }, - "ApplicationScopedVolumeKind": { - "description": "Specifies the application-scoped volume kind.", - "type": "string", - "enum": [ - "ServiceFabricVolumeDisk" - ], - "x-ms-enum": { - "name": "ApplicationScopedVolumeKind", - "modelAsString": true, - "values": [ - { - "value": "ServiceFabricVolumeDisk", - "description": "Provides Service Fabric High Availability Volume Disk" - } - ] - } - }, - "VolumeResourceProperties": { - "description": "This type describes properties of a volume resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/VolumeProperties" - } - ] - }, - "VolumeResourceDescription": { - "description": "This type describes a volume resource.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VolumeResourceProperties", - "description": "This type describes properties of a volume resource." - } - }, - "required": [ - "properties" - ] - }, - "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." - } - } - }, - "NetworkKind": { - "type": "string", - "description": "The type of a Service Fabric container network.", - "enum": [ - "Local" - ], - "x-ms-enum": { - "name": "NetworkKind", - "modelAsString": true, - "values": [ - { - "value": "Local", - "description": "Indicates a container network local to a single Service Fabric cluster. The value is 1." - } - ] - } - }, - "NetworkResourceProperties": { - "description": "Describes properties of a network resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/NetworkResourcePropertiesBase" - } - ], - "properties": { - "description": { - "type": "string", - "description": "User readable description of the network." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ResourceStatus", - "description": "Status of the network." - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the network." - } - } - }, - "LocalNetworkResourceProperties": { - "description": "Information about a Service Fabric container network local to a single Service Fabric cluster.", - "allOf": [ - { - "$ref": "#/definitions/NetworkResourceProperties" - } - ], - "x-ms-discriminator-value": "Local", - "properties": { - "networkAddressPrefix": { - "$ref": "#/definitions/NetworkAddressPrefix", - "description": "Address space for the local container network." - } - } - }, - "NetworkAddressPrefix": { - "type": "string", - "description": "Address space for a container network. This is expressed in CIDR notation." - }, - "NetworkRef": { - "description": "Describes a network reference in a service.", - "properties": { - "name": { - "type": "string", - "description": "Name of the network" - }, - "endpointRefs": { - "description": "A list of endpoints that are exposed on this network.", - "type": "array", - "items": { - "$ref": "#/definitions/EndpointRef" - } - } - } - }, - "EndpointRef": { - "description": "Describes a reference to a service endpoint.", - "properties": { - "name": { - "type": "string", - "description": "Name of the endpoint." - } - } - }, - "NetworkResourcePropertiesBase": { - "discriminator": "kind", - "description": "This type describes the properties of a network resource, including its kind.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - } - ], - "properties": { - "kind": { - "$ref": "#/definitions/NetworkKind", - "description": "The type of a Service Fabric container network." - } - }, - "required": [ - "kind" - ] - }, - "NetworkResourceDescription": { - "description": "This type describes a network resource.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/NetworkResourceProperties", - "description": "Describes properties of a network resource." - } - }, - "required": [ - "properties" - ] - }, - "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." - } - } - }, - "GatewayDestination": { - "description": "Describes destination endpoint for routing traffic.", - "type": "object", - "properties": { - "applicationName": { - "type": "string", - "description": "Name of the service fabric Mesh application." - }, - "serviceName": { - "type": "string", - "description": "service that contains the endpoint." - }, - "endpointName": { - "type": "string", - "description": "name of the endpoint in the service." - } - }, - "required": [ - "applicationName", - "endpointName", - "serviceName" - ] - }, - "GatewayProperties": { - "description": "Describes properties of a gateway resource.", - "properties": { - "description": { - "description": "User readable description of the gateway.", - "type": "string" - }, - "sourceNetwork": { - "$ref": "#/definitions/NetworkRef", - "description": "Network the gateway should listen on for requests." - }, - "destinationNetwork": { - "$ref": "#/definitions/NetworkRef", - "description": "Network that the Application is using." - }, - "tcp": { - "description": "Configuration for tcp connectivity for this gateway.", - "type": "array", - "items": { - "$ref": "#/definitions/TcpConfig" - } - }, - "http": { - "description": "Configuration for http connectivity for this gateway.", - "type": "array", - "items": { - "$ref": "#/definitions/HttpConfig" - } - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ResourceStatus", - "description": "Status of the resource." - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the gateway." - }, - "ipAddress": { - "readOnly": true, - "type": "string", - "description": "IP address of the gateway. This is populated in the response and is ignored for incoming requests." - } - }, - "required": [ - "destinationNetwork", - "sourceNetwork" - ] - }, - "HttpConfig": { - "description": "Describes the http configuration for external connectivity for this network.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "http gateway config name." - }, - "port": { - "type": "integer", - "description": "Specifies the port at which the service endpoint below needs to be exposed." - }, - "hosts": { - "type": "array", - "description": "description for routing.", - "items": { - "$ref": "#/definitions/HttpHostConfig" - } - } - }, - "required": [ - "hosts", - "name", - "port" - ] - }, - "HttpHostConfig": { - "description": "Describes the hostname properties for http routing.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "http hostname config name." - }, - "routes": { - "type": "array", - "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.", - "items": { - "$ref": "#/definitions/HttpRouteConfig" - } - } - }, - "required": [ - "name", - "routes" - ] - }, - "HttpRouteConfig": { - "description": "Describes the hostname properties for http routing.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "http route name." - }, - "match": { - "$ref": "#/definitions/HttpRouteMatchRule", - "description": "Describes a rule for http route matching." - }, - "destination": { - "$ref": "#/definitions/GatewayDestination", - "description": "Describes destination endpoint for routing traffic." - } - }, - "required": [ - "destination", - "match", - "name" - ] - }, - "HttpRouteMatchHeader": { - "description": "Describes header information for http route matching.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of header to match in request." - }, - "value": { - "type": "string", - "description": "Value of header to match in request." - }, - "type": { - "type": "string", - "description": "how to match header value", - "enum": [ - "exact" - ], - "x-ms-enum": { - "name": "HeaderMatchType", - "modelAsString": true - } - } - }, - "required": [ - "name" - ] - }, - "HttpRouteMatchPath": { - "description": "Path to match for routing.", - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Uri path to match for request." - }, - "rewrite": { - "type": "string", - "description": "replacement string for matched part of the Uri." - }, - "type": { - "type": "string", - "description": "how to match value in the Uri", - "enum": [ - "prefix" - ], - "x-ms-enum": { - "name": "PathMatchType", - "modelAsString": true - } - } - }, - "required": [ - "type", - "value" - ] - }, - "HttpRouteMatchRule": { - "description": "Describes a rule for http route matching.", - "type": "object", - "properties": { - "path": { - "$ref": "#/definitions/HttpRouteMatchPath", - "description": "Path to match for routing." - }, - "headers": { - "type": "array", - "description": "headers and their values to match in request.", - "items": { - "$ref": "#/definitions/HttpRouteMatchHeader" - } - } - }, - "required": [ - "path" - ] - }, - "TcpConfig": { - "description": "Describes the tcp configuration for external connectivity for this network.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "tcp gateway config name." - }, - "port": { - "type": "integer", - "description": "Specifies the port at which the service endpoint below needs to be exposed." - }, - "destination": { - "$ref": "#/definitions/GatewayDestination", - "description": "Describes destination endpoint for routing traffic." - } - }, - "required": [ - "destination", - "name", - "port" - ] - }, - "GatewayResourceProperties": { - "description": "This type describes properties of a gateway resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/GatewayProperties" - } - ] - }, - "GatewayResourceDescription": { - "description": "This type describes a gateway resource.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/GatewayResourceProperties", - "description": "This type describes properties of a gateway resource." - } - }, - "required": [ - "properties" - ] - }, - "GatewayResourceDescriptionList": { - "description": "A pageable list of gateway resources.", - "type": "object", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/GatewayResourceDescription" - }, - "description": "One page of the list." - }, - "nextLink": { - "type": "string", - "description": "URI to fetch the next page of the list." - } - } - }, - "ApplicationProperties": { - "description": "Describes properties of a application resource.", - "properties": { - "description": { - "type": "string", - "description": "User readable description of the application." - }, - "services": { - "type": "array", - "description": "Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.", - "items": { - "$ref": "#/definitions/ServiceResourceDescription" - } - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsDescription", - "description": "Describes the diagnostics definition and usage for an application resource." - }, - "debugParams": { - "description": "Internal - used by Visual Studio to setup the debugging session on the local development environment.", - "type": "string" - }, - "serviceNames": { - "readOnly": true, - "description": "Names of the services in the application.", - "type": "array", - "items": { - "type": "string" - } - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ResourceStatus", - "description": "Status of the application." - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the application." - }, - "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." - } - } - }, - "AzureInternalMonitoringPipelineSinkDescription": { - "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" - } - } - }, - "DiagnosticsDescription": { - "description": "Describes the diagnostics options available", - "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.", - "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.", - "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" - ] - }, - "ApplicationResourceProperties": { - "description": "This type describes properties of an application resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/ApplicationProperties" - } - ] - }, - "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" - ] - }, - "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." - } - } - }, - "AddRemoveReplicaScalingMechanism": { - "description": "Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).", - "allOf": [ - { - "$ref": "#/definitions/AutoScalingMechanism" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AddRemoveReplica", - "properties": { - "minCount": { - "type": "integer", - "description": "Minimum number of containers (scale down won't be performed below this number)." - }, - "maxCount": { - "type": "integer", - "description": "Maximum number of containers (scale up won't be performed above this number)." - }, - "scaleIncrement": { - "type": "integer", - "description": "Each time auto scaling is performed, this number of containers will be added or removed." - } - }, - "required": [ - "minCount", - "maxCount", - "scaleIncrement" - ] - }, - "AutoScalingMechanism": { - "type": "object", - "discriminator": "kind", - "description": "Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.", - "properties": { - "kind": { - "$ref": "#/definitions/AutoScalingMechanismKind", - "description": "The type of auto scaling mechanism." - } - }, - "required": [ - "kind" - ] - }, - "AutoScalingMechanismKind": { - "type": "string", - "description": "Enumerates the mechanisms for auto scaling.", - "enum": [ - "AddRemoveReplica" - ], - "x-ms-enum": { - "name": "AutoScalingMechanismKind", - "modelAsString": true, - "values": [ - { - "value": "AddRemoveReplica", - "description": "Indicates that scaling should be performed by adding or removing replicas." - } - ] - } - }, - "AutoScalingMetric": { - "type": "object", - "discriminator": "kind", - "description": "Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.", - "properties": { - "kind": { - "$ref": "#/definitions/AutoScalingMetricKind", - "description": "The type of auto scaling metric" - } - }, - "required": [ - "kind" - ] - }, - "AutoScalingMetricKind": { - "type": "string", - "description": "Enumerates the metrics that are used for triggering auto scaling.", - "enum": [ - "Resource" - ], - "x-ms-enum": { - "name": "AutoScalingMetricKind", - "modelAsString": true, - "values": [ - { - "value": "Resource", - "description": "Indicates that the metric is one of resources, like cpu or memory." - } - ] - } - }, - "AutoScalingPolicy": { - "description": "Describes the auto scaling policy", - "type": "object", - "properties": { - "name": { - "description": "The name of the auto scaling policy.", - "type": "string" - }, - "trigger": { - "$ref": "#/definitions/AutoScalingTrigger", - "description": "Determines when auto scaling operation will be invoked." - }, - "mechanism": { - "$ref": "#/definitions/AutoScalingMechanism", - "description": "The mechanism that is used to scale when auto scaling operation is invoked." - } - }, - "required": [ - "name", - "trigger", - "mechanism" - ] - }, - "AutoScalingResourceMetric": { - "description": "Describes the resource that is used for triggering auto scaling.", - "allOf": [ - { - "$ref": "#/definitions/AutoScalingMetric" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "Resource", - "properties": { - "name": { - "$ref": "#/definitions/AutoScalingResourceMetricName", - "description": "Name of the resource." - } - }, - "required": [ - "name" - ] - }, - "AutoScalingResourceMetricName": { - "type": "string", - "description": "Enumerates the resources that are used for triggering auto scaling.", - "enum": [ - "cpu", - "memoryInGB" - ], - "x-ms-enum": { - "name": "AutoScalingResourceMetricName", - "modelAsString": true, - "values": [ - { - "value": "cpu", - "description": "Indicates that the resource is CPU cores." - }, - { - "value": "memoryInGB", - "description": "Indicates that the resource is memory in GB." - } - ] - } - }, - "AutoScalingTrigger": { - "type": "object", - "discriminator": "kind", - "description": "Describes the trigger for performing auto scaling operation.", - "properties": { - "kind": { - "$ref": "#/definitions/AutoScalingTriggerKind", - "description": "The type of auto scaling trigger" - } - }, - "required": [ - "kind" - ] - }, - "AutoScalingTriggerKind": { - "type": "string", - "description": "Enumerates the triggers for auto scaling.", - "enum": [ - "AverageLoad" - ], - "x-ms-enum": { - "name": "AutoScalingTriggerKind", - "modelAsString": true, - "values": [ - { - "value": "AverageLoad", - "description": "Indicates that scaling should be performed based on average load of all replicas in the service." - } - ] - } - }, - "ContainerCodePackageProperties": { - "description": "Describes a container and its runtime properties.", - "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": { - "description": "The resources required by this container.", - "$ref": "#/definitions/ResourceRequirements" - }, - "volumeRefs": { - "description": "Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.", - "type": "array", - "items": { - "$ref": "#/definitions/VolumeReference" - } - }, - "volumes": { - "description": "Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.", - "type": "array", - "items": { - "$ref": "#/definitions/ApplicationScopedVolume" - } - }, - "diagnostics": { - "$ref": "#/definitions/DiagnosticsRef", - "description": "Reference to sinks in DiagnosticsDescription." - }, - "reliableCollectionsRefs": { - "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.", - "type": "array", - "items": { - "$ref": "#/definitions/ReliableCollectionsRef" - } - }, - "instanceView": { - "readOnly": true, - "$ref": "#/definitions/ContainerInstanceView", - "description": "Runtime information of a container instance." - } - }, - "required": [ - "name", - "image", - "resources" - ] - }, - "ContainerEvent": { - "description": "A container event.", - "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.", - "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.", - "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.", - "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" - } - } - }, - "EndpointProperties": { - "description": "Describes a container endpoint.", - "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.", - "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.", - "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. The password is required for create or update operations, however it is not returned in the get or list operations." - } - }, - "required": [ - "server", - "username" - ] - }, - "OperatingSystemType": { - "type": "string", - "description": "The operation system required by the code in service.", - "enum": [ - "Linux", - "Windows" - ], - "x-ms-enum": { - "name": "OperatingSystemType", - "modelAsString": true, - "values": [ - { - "value": "Linux", - "description": "The required operating system is Linux." - }, - { - "value": "Windows", - "description": "The required operating system is Windows." - } - ] - } - }, - "ReliableCollectionsRef": { - "description": "Specifying this parameter adds support for reliable collections", - "properties": { - "name": { - "description": "Name of ReliableCollection resource. Right now it's not used and you can use any string.", - "type": "string" - }, - "doNotPersistState": { - "description": "False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.", - "type": "boolean" - } - }, - "required": [ - "name" - ] - }, - "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.", - "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.", - "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.", - "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" - ] - }, - "ServiceProperties": { - "description": "Describes properties of a service resource.", - "properties": { - "description": { - "type": "string", - "description": "User readable description of the service." - }, - "replicaCount": { - "type": "integer", - "description": "The number of replicas of the service to create. Defaults to 1 if not specified." - }, - "autoScalingPolicies": { - "type": "array", - "items": { - "$ref": "#/definitions/AutoScalingPolicy" - }, - "description": "Auto scaling policies" - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/ResourceStatus", - "description": "Status of the service." - }, - "statusDetails": { - "readOnly": true, - "type": "string", - "description": "Gives additional information about the current status of the service." - }, - "healthState": { - "readOnly": true, - "$ref": "#/definitions/HealthState", - "description": "Describes the health state of an application resource." - }, - "unhealthyEvaluation": { - "readOnly": true, - "type": "string", - "description": "When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy." - } - } - }, - "ServiceReplicaProperties": { - "description": "Describes the properties of a service replica.", - "properties": { - "osType": { - "$ref": "#/definitions/OperatingSystemType", - "description": "The operation system required by the code in service." - }, - "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. 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\".", - "properties": { - "name": { - "description": "The name of the setting.", - "type": "string" - }, - "value": { - "description": "The value of the setting.", - "type": "string" - } - } - }, - "ServiceReplicaDescription": { - "description": "Describes a replica of a service resource.", - "allOf": [ - { - "$ref": "#/definitions/ServiceReplicaProperties" - } - ], - "properties": { - "replicaName": { - "type": "string", - "description": "Name of the replica." - } - }, - "required": [ - "replicaName" - ] - }, - "AverageLoadScalingTrigger": { - "description": "Describes the average load trigger used for auto scaling.", - "allOf": [ - { - "$ref": "#/definitions/AutoScalingTrigger" - }, - { - "type": "object" - } - ], - "x-ms-discriminator-value": "AverageLoad", - "properties": { - "metric": { - "$ref": "#/definitions/AutoScalingMetric", - "description": "Description of the metric that is used for scaling." - }, - "lowerLoadThreshold": { - "type": "number", - "format": "double", - "description": "Lower load threshold (if average load is below this threshold, service will scale down)." - }, - "upperLoadThreshold": { - "type": "number", - "format": "double", - "description": "Upper load threshold (if average load is above this threshold, service will scale up)." - }, - "scaleIntervalInSeconds": { - "type": "integer", - "description": "Scale interval that indicates how often will this trigger be checked.", - "minimum": 60 - } - }, - "required": [ - "metric", - "lowerLoadThreshold", - "upperLoadThreshold", - "scaleIntervalInSeconds" - ] - }, - "ServiceResourceProperties": { - "description": "This type describes properties of a service resource.", - "allOf": [ - { - "$ref": "#/definitions/ProvisionedResourceProperties" - }, - { - "$ref": "#/definitions/ServiceReplicaProperties" - }, - { - "$ref": "#/definitions/ServiceProperties" - } - ] - }, - "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" - ] - }, - "ServiceResourceDescriptionList": { - "description": "A pageable list of service resources.", - "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." - } - } - }, - "ServiceReplicaDescriptionList": { - "description": "A pageable list of service replicas.", - "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." - } - } - }, - "ContainerLogs": { - "description": "Container logs.", - "properties": { - "content": { - "type": "string", - "description": "Container logs." - } - } - } - }, - "parameters": { - "CodePackageNameRequiredPathParam": { - "name": "codePackageName", - "in": "path", - "x-ms-parameter-location": "method", - "type": "string", - "required": true, - "description": "The name of code package of the service." - }, - "api-versionRequiredQueryParam": { - "name": "api-version", - "in": "query", - "type": "string", - "enum": [ - "2018-09-01-preview" - ], - "default": "2018-09-01-preview", - "description": "The version of the API. This parameter is required and its value must be `2018-09-01-preview`.", - "required": true, - "x-ms-enum": { - "name": "2018-09-01-preview", - "modelAsString": true, - "values": [ - { - "value": "2018-09-01-preview", - "description": "The `2018-09-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" - }, - "SecretResourceDescriptionRequiredBodyParam": { - "name": "secretResourceDescription", - "in": "body", - "description": "Description for creating a secret resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/SecretResourceDescription" - } - }, - "SecretResourceNameRequiredPathParam": { - "name": "secretResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The name of the secret resource." - }, - "SecretValueResourceDescriptionRequiredBodyParam": { - "name": "secretValueResourceDescription", - "in": "body", - "description": "Description for creating a value of a secret resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/SecretValueResourceDescription" - } - }, - "SecretValueResourceNameRequiredPathParam": { - "name": "secretValueResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The name of the secret resource value which is typically the version identifier for the value." - }, - "VolumeResourceDescriptionRequiredBodyParam": { - "name": "volumeResourceDescription", - "in": "body", - "description": "Description for creating a Volume resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/VolumeResourceDescription" - } - }, - "VolumeResourceNameRequiredPathParam": { - "name": "volumeResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the volume." - }, - "NetworkResourceDescriptionRequiredBodyParam": { - "name": "networkResourceDescription", - "in": "body", - "description": "Description for creating a Network resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/NetworkResourceDescription" - } - }, - "NetworkResourceNameRequiredPathParam": { - "name": "networkResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the network." - }, - "GatewayResourceDescriptionRequiredBodyParam": { - "name": "gatewayResourceDescription", - "in": "body", - "description": "Description for creating a Gateway resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/GatewayResourceDescription" - } - }, - "GatewayResourceNameRequiredPathParam": { - "name": "gatewayResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the gateway." - }, - "ApplicationResourceDescriptionRequiredBodyParam": { - "name": "applicationResourceDescription", - "in": "body", - "description": "Description for creating a Application resource.", - "required": true, - "x-ms-parameter-location": "method", - "schema": { - "$ref": "#/definitions/ApplicationResourceDescription" - } - }, - "ApplicationResourceNameRequiredPathParam": { - "name": "applicationResourceName", - "in": "path", - "x-ms-parameter-location": "method", - "x-ms-skip-url-encoding": true, - "type": "string", - "required": true, - "description": "The identity of the application." - }, - "ServiceResourceNameRequiredPathParam": { - "name": "serviceResourceName", - "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": "Service Fabric replica name." - }, - "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-09-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.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/secrets/{secretResourceName}": { + "put": { + "operationId": "Secret_Create", + "x-ms-examples": { + "CreateOrUpdateSecret": { + "$ref": "./examples/secrets/create_update.json" + } + }, + "summary": "Creates or updates a secret resource.", + "description": "Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Secret_Get", + "x-ms-examples": { + "GetSecret": { + "$ref": "./examples/secrets/get.json" + } + }, + "summary": "Gets the secret resource with the given name.", + "description": "Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Secret_Delete", + "x-ms-examples": { + "DeleteSecret": { + "$ref": "./examples/secrets/delete.json" + } + }, + "summary": "Deletes the secret resource.", + "description": "Deletes the secret resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified secret was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets": { + "get": { + "operationId": "Secret_ListByResourceGroup", + "x-ms-examples": { + "ListSecretsByResourceGroup": { + "$ref": "./examples/secrets/list_byResourceGroup.json" + } + }, + "summary": "Gets all the secret resources in a given resource group.", + "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/secrets": { + "get": { + "operationId": "Secret_ListBySubscription", + "x-ms-examples": { + "ListSecretsBySubscriptionId": { + "$ref": "./examples/secrets/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the secret resources in a given subscription.", + "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}": { + "put": { + "operationId": "SecretValue_Create", + "x-ms-examples": { + "CreateSecretValue": { + "$ref": "./examples/secrets/values/create.json" + } + }, + "summary": "Adds the specified value as a new version of the specified secret resource.", + "description": "Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "SecretValue_Get", + "x-ms-examples": { + "GetSecretValue": { + "$ref": "./examples/secrets/values/get.json" + } + }, + "summary": "Gets the specified secret value resource.", + "description": "Get the information about the specified named secret value resources. The information does not include the actual value of the secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "SecretValue_Delete", + "x-ms-examples": { + "DeleteSecretValue": { + "$ref": "./examples/secrets/values/delete.json" + } + }, + "summary": "Deletes the specified value of the named secret resource.", + "description": "Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified named secret value was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values": { + "get": { + "operationId": "SecretValue_List", + "x-ms-examples": { + "ListSecretValues": { + "$ref": "./examples/secrets/values/list.json" + } + }, + "summary": "List names of all values of the specified secret resource.", + "description": "Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}/list_value": { + "post": { + "operationId": "SecretValue_ListValue", + "x-ms-examples": { + "ListSecretValue": { + "$ref": "./examples/secrets/values/list_value.json" + } + }, + "summary": "Lists the specified value of the secret resource.", + "description": "Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValue" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}": { + "put": { + "operationId": "Volume_Create", + "x-ms-examples": { + "CreateOrUpdateVolume": { + "$ref": "./examples/volumes/create_update.json" + } + }, + "summary": "Creates or updates a volume resource.", + "description": "Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Volume_Get", + "x-ms-examples": { + "GetVolume": { + "$ref": "./examples/volumes/get.json" + } + }, + "summary": "Gets the volume resource with the given name.", + "description": "Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Volume_Delete", + "x-ms-examples": { + "DeleteVolume": { + "$ref": "./examples/volumes/delete.json" + } + }, + "summary": "Deletes the volume resource.", + "description": "Deletes the volume resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "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": { + "ListVolumesByResourceGroup": { + "$ref": "./examples/volumes/list_byResourceGroup.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 include the description and other properties of the Volume.", + "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": { + "ListVolumesBySubscriptionId": { + "$ref": "./examples/volumes/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the volume resources in a given subscription.", + "description": "Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.", + "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" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}": { + "put": { + "operationId": "Network_Create", + "x-ms-examples": { + "CreateOrUpdateNetwork": { + "$ref": "./examples/networks/create_update.json" + } + }, + "summary": "Creates or updates a network resource.", + "description": "Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Network_Get", + "x-ms-examples": { + "GetNetwork": { + "$ref": "./examples/networks/get.json" + } + }, + "summary": "Gets the network resource with the given name.", + "description": "Gets the information about the network resource with the given name. The information include the description and other properties of the network.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Network_Delete", + "x-ms-examples": { + "DeleteNetwork": { + "$ref": "./examples/networks/delete.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/NetworkResourceNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "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": { + "ListNetworksByResourceGroup": { + "$ref": "./examples/networks/list_byResourceGroup.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 include the description and other properties of the Network.", + "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": { + "ListNetworksBySubscriptionId": { + "$ref": "./examples/networks/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the network resources in a given subscription.", + "description": "Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.", + "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/gateways/{gatewayResourceName}": { + "put": { + "operationId": "Gateway_Create", + "x-ms-examples": { + "CreateOrUpdateGateway": { + "$ref": "./examples/gateways/create_update.json" + } + }, + "summary": "Creates or updates a gateway resource.", + "description": "Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Gateway_Get", + "x-ms-examples": { + "GetGateway": { + "$ref": "./examples/gateways/get.json" + } + }, + "summary": "Gets the gateway resource with the given name.", + "description": "Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Gateway_Delete", + "x-ms-examples": { + "DeleteGateway": { + "$ref": "./examples/gateways/delete.json" + } + }, + "summary": "Deletes the gateway resource.", + "description": "Deletes the gateway resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified gateway was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways": { + "get": { + "operationId": "Gateway_ListByResourceGroup", + "x-ms-examples": { + "ListGatewaysByResourceGroup": { + "$ref": "./examples/gateways/list_byResourceGroup.json" + } + }, + "summary": "Gets all the gateway resources in a given resource group.", + "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/gateways": { + "get": { + "operationId": "Gateway_ListBySubscription", + "x-ms-examples": { + "ListGatewaysBySubscriptionId": { + "$ref": "./examples/gateways/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the gateway resources in a given subscription.", + "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}": { + "put": { + "operationId": "Application_Create", + "x-ms-examples": { + "CreateOrUpdateApplication": { + "$ref": "./examples/applications/create_update.json" + } + }, + "summary": "Creates or updates an application resource.", + "description": "Creates an application resource with the specified name, description and properties. If an application resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Application_Get", + "x-ms-examples": { + "GetApplication": { + "$ref": "./examples/applications/get.json" + } + }, + "summary": "Gets the application resource with the given name.", + "description": "Gets the information about the application resource with the given name. The information include the description and other properties of the application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Application_Delete", + "x-ms-examples": { + "DeleteApplication": { + "$ref": "./examples/applications/delete.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/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "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": { + "get": { + "operationId": "Application_ListByResourceGroup", + "x-ms-examples": { + "ListApplicationsByResourceGroup": { + "$ref": "./examples/applications/list_byResourceGroup.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 include the description and other properties of the Application.", + "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": { + "ListApplicationsBySubscriptionId": { + "$ref": "./examples/applications/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the application resources in a given subscription.", + "description": "Gets the information about all application resources in a given resource group. The information include the description and other properties of the application.", + "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/{applicationResourceName}/services/{serviceResourceName}": { + "get": { + "operationId": "Service_Get", + "x-ms-examples": { + "GetService": { + "$ref": "./examples/applications/services/get.json" + } + }, + "summary": "Gets the service resource with the given name.", + "description": "Gets the information about the service resource with the given name. The information include the description and other properties of the service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services": { + "get": { + "operationId": "Service_List", + "x-ms-examples": { + "ListServices": { + "$ref": "./examples/applications/services/list.json" + } + }, + "summary": "Lists all the service resources.", + "description": "Gets the information about all services of an application resource. The information include the description and other properties of the Service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}": { + "get": { + "operationId": "ServiceReplica_Get", + "x-ms-examples": { + "ReplicaGet": { + "$ref": "./examples/applications/services/replicas/get.json" + } + }, + "summary": "Gets the given replica of the service of an application.", + "description": "Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + } + ], + "tags": [ + "ServiceReplicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas": { + "get": { + "operationId": "ServiceReplica_List", + "x-ms-examples": { + "ReplicasGetAll": { + "$ref": "./examples/applications/services/replicas/list.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/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "ServiceReplicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs": { + "get": { + "operationId": "CodePackage_GetContainerLogs", + "x-ms-examples": { + "GetContainerLogs": { + "$ref": "./examples/applications/services/replicas/codepackages/get_logs.json" + } + }, + "summary": "Gets the logs from the container.", + "description": "Gets the logs for the container of the specified code package of the service replica.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + } + ], + "tags": [ + "CodePackages" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "ResourceStatus": { + "description": "Status of the resource.", + "type": "string", + "enum": [ + "Unknown", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ResourceStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the resource status is unknown. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates the resource is ready. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the resource is upgrading. The value is 2." + }, + { + "value": "Creating", + "description": "Indicates the resource is being created. The value is 3." + }, + { + "value": "Deleting", + "description": "Indicates the resource is being deleted. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5." + } + ] + } + }, + "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." + } + ] + } + }, + "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": { + "error": { + "$ref": "#/definitions/ErrorErrorModel", + "description": "Error model information" + } + }, + "description": "The error details.", + "required": [ + "error" + ] + }, + "ErrorErrorModel": { + "description": "Error model information", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string", + "description": "Error message." + }, + "innerError": { + "type": "string" + }, + "details": { + "type": "array", + "description": "List of error message details.", + "items": { + "$ref": "#/definitions/ErrorDetailsModel" + } + } + }, + "required": [ + "code" + ] + }, + "ErrorDetailsModel": { + "description": "Error model details information", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + }, + "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." + }, + "ProvisionedResourceProperties": { + "description": "Describes common properties of a provisioned resource.", + "properties": { + "provisioningState": { + "type": "string", + "description": "State of the resource.", + "readOnly": 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 + }, + "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" + ] + } + }, + "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" + ] + }, + "SecretKind": { + "type": "string", + "description": "Describes the kind of secret.", + "enum": [ + "inlinedValue" + ], + "x-ms-enum": { + "name": "SecretKind", + "modelAsString": true, + "values": [ + { + "value": "inlinedValue", + "description": "A simple secret resource whose plaintext value is provided by the user." + } + ] + } + }, + "SecretResourceProperties": { + "description": "Describes the properties of a secret resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretResourcePropertiesBase" + } + ], + "properties": { + "description": { + "description": "User readable description of the secret.", + "type": "string" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the resource." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the secret." + }, + "contentType": { + "type": "string", + "description": "The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed." + } + } + }, + "InlinedValueSecretResourceProperties": { + "description": "Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.", + "allOf": [ + { + "$ref": "#/definitions/SecretResourceProperties" + } + ], + "x-ms-discriminator-value": "inlinedValue" + }, + "SecretResourcePropertiesBase": { + "discriminator": "kind", + "description": "This type describes the properties of a secret resource, including its kind.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/SecretKind", + "description": "Describes the kind of secret." + } + }, + "required": [ + "kind" + ] + }, + "SecretResourceDescription": { + "description": "This type describes a secret resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecretResourceProperties", + "description": "Describes the properties of a secret resource." + } + }, + "required": [ + "properties" + ] + }, + "SecretResourceDescriptionList": { + "description": "A pageable list of secret resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecretResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "SecretValue": { + "type": "object", + "description": "This type represents the unencrypted value of the secret.", + "properties": { + "value": { + "type": "string", + "description": "The actual value of the secret." + } + } + }, + "SecretValueProperties": { + "type": "object", + "description": "This type describes properties of secret value resource.", + "properties": { + "value": { + "type": "string", + "description": "The actual value of the secret." + } + } + }, + "SecretValueResourceProperties": { + "description": "This type describes properties of a secret value resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/SecretValueProperties" + } + ] + }, + "SecretValueResourceDescription": { + "description": "This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecretValueResourceProperties", + "description": "This type describes properties of a secret value resource." + } + }, + "required": [ + "properties" + ] + }, + "SecretValueResourceDescriptionList": { + "description": "A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unencrypted value.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecretValueResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "VolumeProperties": { + "description": "Describes properties of a volume resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the volume." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the volume." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the volume." + }, + "provider": { + "$ref": "#/definitions/VolumeProvider", + "description": "Provider of the volume." + }, + "azureFileParameters": { + "$ref": "#/definitions/VolumeProviderParametersAzureFile", + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ] + }, + "VolumeProvider": { + "type": "string", + "description": "Describes the provider of the volume resource.", + "enum": [ + "SFAzureFile" + ], + "x-ms-enum": { + "name": "VolumeProvider", + "modelAsString": true, + "values": [ + { + "value": "SFAzureFile", + "description": "Provides volumes that are backed by Azure Files." + } + ] + } + }, + "VolumeProviderParametersAzureFile": { + "description": "This type describes a volume provided by an Azure Files file share.", + "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" + ] + }, + "VolumeReference": { + "description": "Describes a reference to a volume resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the volume being referenced." + }, + "readOnly": { + "type": "boolean", + "description": "The flag indicating whether the volume is read only. Default is 'false'." + }, + "destinationPath": { + "type": "string", + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed." + } + }, + "required": [ + "name", + "destinationPath" + ] + }, + "ApplicationScopedVolume": { + "description": "Describes a volume whose lifetime is scoped to the application's lifetime.", + "allOf": [ + { + "$ref": "#/definitions/VolumeReference" + } + ], + "properties": { + "creationParameters": { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters", + "description": "Describes parameters for creating application-scoped volumes." + } + }, + "required": [ + "creationParameters" + ] + }, + "ApplicationScopedVolumeCreationParameters": { + "description": "Describes parameters for creating application-scoped volumes.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/ApplicationScopedVolumeKind", + "description": "Specifies the application-scoped volume kind." + }, + "description": { + "description": "User readable description of the volume.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk": { + "description": "Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks", + "allOf": [ + { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters" + } + ], + "properties": { + "sizeDisk": { + "description": "Volume size", + "type": "string", + "enum": [ + "Small", + "Medium", + "Large" + ], + "x-ms-enum": { + "name": "SizeTypes", + "modelAsString": true + } + } + }, + "required": [ + "sizeDisk" + ], + "x-ms-discriminator-value": "ServiceFabricVolumeDisk" + }, + "ApplicationScopedVolumeKind": { + "description": "Specifies the application-scoped volume kind.", + "type": "string", + "enum": [ + "ServiceFabricVolumeDisk" + ], + "x-ms-enum": { + "name": "ApplicationScopedVolumeKind", + "modelAsString": true, + "values": [ + { + "value": "ServiceFabricVolumeDisk", + "description": "Provides Service Fabric High Availability Volume Disk" + } + ] + } + }, + "VolumeResourceProperties": { + "description": "This type describes properties of a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/VolumeProperties" + } + ] + }, + "VolumeResourceDescription": { + "description": "This type describes a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeResourceProperties", + "description": "This type describes properties of a volume resource." + } + }, + "required": [ + "properties" + ] + }, + "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." + } + } + }, + "NetworkKind": { + "type": "string", + "description": "The type of a Service Fabric container network.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "NetworkKind", + "modelAsString": true, + "values": [ + { + "value": "Local", + "description": "Indicates a container network local to a single Service Fabric cluster. The value is 1." + } + ] + } + }, + "NetworkResourceProperties": { + "description": "Describes properties of a network resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkResourcePropertiesBase" + } + ], + "properties": { + "description": { + "type": "string", + "description": "User readable description of the network." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the network." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the network." + } + } + }, + "LocalNetworkResourceProperties": { + "description": "Information about a Service Fabric container network local to a single Service Fabric cluster.", + "allOf": [ + { + "$ref": "#/definitions/NetworkResourceProperties" + } + ], + "x-ms-discriminator-value": "Local", + "properties": { + "networkAddressPrefix": { + "$ref": "#/definitions/NetworkAddressPrefix", + "description": "Address space for the local container network." + } + } + }, + "NetworkAddressPrefix": { + "type": "string", + "description": "Address space for a container network. This is expressed in CIDR notation." + }, + "NetworkRef": { + "description": "Describes a network reference in a service.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network" + }, + "endpointRefs": { + "description": "A list of endpoints that are exposed on this network.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointRef" + } + } + } + }, + "EndpointRef": { + "description": "Describes a reference to a service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint." + } + } + }, + "NetworkResourcePropertiesBase": { + "discriminator": "kind", + "description": "This type describes the properties of a network resource, including its kind.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/NetworkKind", + "description": "The type of a Service Fabric container network." + } + }, + "required": [ + "kind" + ] + }, + "NetworkResourceDescription": { + "description": "This type describes a network resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkResourceProperties", + "description": "Describes properties of a network resource." + } + }, + "required": [ + "properties" + ] + }, + "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." + } + } + }, + "GatewayDestination": { + "description": "Describes destination endpoint for routing traffic.", + "type": "object", + "properties": { + "applicationName": { + "type": "string", + "description": "Name of the service fabric Mesh application." + }, + "serviceName": { + "type": "string", + "description": "service that contains the endpoint." + }, + "endpointName": { + "type": "string", + "description": "name of the endpoint in the service." + } + }, + "required": [ + "applicationName", + "endpointName", + "serviceName" + ] + }, + "GatewayProperties": { + "description": "Describes properties of a gateway resource.", + "properties": { + "description": { + "description": "User readable description of the gateway.", + "type": "string" + }, + "sourceNetwork": { + "$ref": "#/definitions/NetworkRef", + "description": "Network the gateway should listen on for requests." + }, + "destinationNetwork": { + "$ref": "#/definitions/NetworkRef", + "description": "Network that the Application is using." + }, + "tcp": { + "description": "Configuration for tcp connectivity for this gateway.", + "type": "array", + "items": { + "$ref": "#/definitions/TcpConfig" + } + }, + "http": { + "description": "Configuration for http connectivity for this gateway.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpConfig" + } + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the resource." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the gateway." + }, + "ipAddress": { + "readOnly": true, + "type": "string", + "description": "IP address of the gateway. This is populated in the response and is ignored for incoming requests." + } + }, + "required": [ + "destinationNetwork", + "sourceNetwork" + ] + }, + "HttpConfig": { + "description": "Describes the http configuration for external connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http gateway config name." + }, + "port": { + "type": "integer", + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "hosts": { + "type": "array", + "description": "description for routing.", + "items": { + "$ref": "#/definitions/HttpHostConfig" + } + } + }, + "required": [ + "hosts", + "name", + "port" + ] + }, + "HttpHostConfig": { + "description": "Describes the hostname properties for http routing.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http hostname config name." + }, + "routes": { + "type": "array", + "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.", + "items": { + "$ref": "#/definitions/HttpRouteConfig" + } + } + }, + "required": [ + "name", + "routes" + ] + }, + "HttpRouteConfig": { + "description": "Describes the hostname properties for http routing.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http route name." + }, + "match": { + "$ref": "#/definitions/HttpRouteMatchRule", + "description": "Describes a rule for http route matching." + }, + "destination": { + "$ref": "#/definitions/GatewayDestination", + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "destination", + "match", + "name" + ] + }, + "HttpRouteMatchHeader": { + "description": "Describes header information for http route matching.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of header to match in request." + }, + "value": { + "type": "string", + "description": "Value of header to match in request." + }, + "type": { + "type": "string", + "description": "how to match header value", + "enum": [ + "exact" + ], + "x-ms-enum": { + "name": "HeaderMatchType", + "modelAsString": true + } + } + }, + "required": [ + "name" + ] + }, + "HttpRouteMatchPath": { + "description": "Path to match for routing.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Uri path to match for request." + }, + "rewrite": { + "type": "string", + "description": "replacement string for matched part of the Uri." + }, + "type": { + "type": "string", + "description": "how to match value in the Uri", + "enum": [ + "prefix" + ], + "x-ms-enum": { + "name": "PathMatchType", + "modelAsString": true + } + } + }, + "required": [ + "type", + "value" + ] + }, + "HttpRouteMatchRule": { + "description": "Describes a rule for http route matching.", + "type": "object", + "properties": { + "path": { + "$ref": "#/definitions/HttpRouteMatchPath", + "description": "Path to match for routing." + }, + "headers": { + "type": "array", + "description": "headers and their values to match in request.", + "items": { + "$ref": "#/definitions/HttpRouteMatchHeader" + } + } + }, + "required": [ + "path" + ] + }, + "TcpConfig": { + "description": "Describes the tcp configuration for external connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "tcp gateway config name." + }, + "port": { + "type": "integer", + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "destination": { + "$ref": "#/definitions/GatewayDestination", + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "destination", + "name", + "port" + ] + }, + "GatewayResourceProperties": { + "description": "This type describes properties of a gateway resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/GatewayProperties" + } + ] + }, + "GatewayResourceDescription": { + "description": "This type describes a gateway resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayResourceProperties", + "description": "This type describes properties of a gateway resource." + } + }, + "required": [ + "properties" + ] + }, + "GatewayResourceDescriptionList": { + "description": "A pageable list of gateway resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ApplicationProperties": { + "description": "Describes properties of a application resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the application." + }, + "services": { + "type": "array", + "description": "Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsDescription", + "description": "Describes the diagnostics definition and usage for an application resource." + }, + "debugParams": { + "description": "Internal - used by Visual Studio to setup the debugging session on the local development environment.", + "type": "string" + }, + "serviceNames": { + "readOnly": true, + "description": "Names of the services in the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the application." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the application." + }, + "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." + } + } + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "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" + } + } + }, + "DiagnosticsDescription": { + "description": "Describes the diagnostics options available", + "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.", + "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.", + "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" + ] + }, + "ApplicationResourceProperties": { + "description": "This type describes properties of an application resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/ApplicationProperties" + } + ] + }, + "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" + ] + }, + "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." + } + } + }, + "AddRemoveReplicaScalingMechanism": { + "description": "Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingMechanism" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AddRemoveReplica", + "properties": { + "minCount": { + "type": "integer", + "description": "Minimum number of containers (scale down won't be performed below this number)." + }, + "maxCount": { + "type": "integer", + "description": "Maximum number of containers (scale up won't be performed above this number)." + }, + "scaleIncrement": { + "type": "integer", + "description": "Each time auto scaling is performed, this number of containers will be added or removed." + } + }, + "required": [ + "minCount", + "maxCount", + "scaleIncrement" + ] + }, + "AutoScalingMechanism": { + "type": "object", + "discriminator": "kind", + "description": "Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingMechanismKind", + "description": "The type of auto scaling mechanism." + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingMechanismKind": { + "type": "string", + "description": "Enumerates the mechanisms for auto scaling.", + "enum": [ + "AddRemoveReplica" + ], + "x-ms-enum": { + "name": "AutoScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "AddRemoveReplica", + "description": "Indicates that scaling should be performed by adding or removing replicas." + } + ] + } + }, + "AutoScalingMetric": { + "type": "object", + "discriminator": "kind", + "description": "Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingMetricKind", + "description": "The type of auto scaling metric" + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingMetricKind": { + "type": "string", + "description": "Enumerates the metrics that are used for triggering auto scaling.", + "enum": [ + "Resource" + ], + "x-ms-enum": { + "name": "AutoScalingMetricKind", + "modelAsString": true, + "values": [ + { + "value": "Resource", + "description": "Indicates that the metric is one of resources, like cpu or memory." + } + ] + } + }, + "AutoScalingPolicy": { + "description": "Describes the auto scaling policy", + "type": "object", + "properties": { + "name": { + "description": "The name of the auto scaling policy.", + "type": "string" + }, + "trigger": { + "$ref": "#/definitions/AutoScalingTrigger", + "description": "Determines when auto scaling operation will be invoked." + }, + "mechanism": { + "$ref": "#/definitions/AutoScalingMechanism", + "description": "The mechanism that is used to scale when auto scaling operation is invoked." + } + }, + "required": [ + "name", + "trigger", + "mechanism" + ] + }, + "AutoScalingResourceMetric": { + "description": "Describes the resource that is used for triggering auto scaling.", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingMetric" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "Resource", + "properties": { + "name": { + "$ref": "#/definitions/AutoScalingResourceMetricName", + "description": "Name of the resource." + } + }, + "required": [ + "name" + ] + }, + "AutoScalingResourceMetricName": { + "type": "string", + "description": "Enumerates the resources that are used for triggering auto scaling.", + "enum": [ + "cpu", + "memoryInGB" + ], + "x-ms-enum": { + "name": "AutoScalingResourceMetricName", + "modelAsString": true, + "values": [ + { + "value": "cpu", + "description": "Indicates that the resource is CPU cores." + }, + { + "value": "memoryInGB", + "description": "Indicates that the resource is memory in GB." + } + ] + } + }, + "AutoScalingTrigger": { + "type": "object", + "discriminator": "kind", + "description": "Describes the trigger for performing auto scaling operation.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingTriggerKind", + "description": "The type of auto scaling trigger" + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingTriggerKind": { + "type": "string", + "description": "Enumerates the triggers for auto scaling.", + "enum": [ + "AverageLoad" + ], + "x-ms-enum": { + "name": "AutoScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "AverageLoad", + "description": "Indicates that scaling should be performed based on average load of all replicas in the service." + } + ] + } + }, + "ContainerCodePackageProperties": { + "description": "Describes a container and its runtime properties.", + "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": { + "description": "The resources required by this container.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeRefs": { + "description": "Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeReference" + } + }, + "volumes": { + "description": "Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationScopedVolume" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + }, + "reliableCollectionsRefs": { + "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReliableCollectionsRef" + } + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/ContainerInstanceView", + "description": "Runtime information of a container instance." + } + }, + "required": [ + "name", + "image", + "resources" + ] + }, + "ContainerEvent": { + "description": "A container event.", + "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.", + "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.", + "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.", + "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" + } + } + }, + "EndpointProperties": { + "description": "Describes a container endpoint.", + "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.", + "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.", + "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. The password is required for create or update operations, however it is not returned in the get or list operations." + } + }, + "required": [ + "server", + "username" + ] + }, + "OperatingSystemType": { + "type": "string", + "description": "The operation system required by the code in service.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "The required operating system is Linux." + }, + { + "value": "Windows", + "description": "The required operating system is Windows." + } + ] + } + }, + "ReliableCollectionsRef": { + "description": "Specifying this parameter adds support for reliable collections", + "properties": { + "name": { + "description": "Name of ReliableCollection resource. Right now it's not used and you can use any string.", + "type": "string" + }, + "doNotPersistState": { + "description": "False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.", + "type": "boolean" + } + }, + "required": [ + "name" + ] + }, + "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.", + "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.", + "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.", + "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" + ] + }, + "ServiceProperties": { + "description": "Describes properties of a service resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the service." + }, + "replicaCount": { + "type": "integer", + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "autoScalingPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScalingPolicy" + }, + "description": "Auto scaling policies" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the service." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the service." + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy." + } + } + }, + "ServiceReplicaProperties": { + "description": "Describes the properties of a service replica.", + "properties": { + "osType": { + "$ref": "#/definitions/OperatingSystemType", + "description": "The operation system required by the code in service." + }, + "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. 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\".", + "properties": { + "name": { + "description": "The name of the setting.", + "type": "string" + }, + "value": { + "description": "The value of the setting.", + "type": "string" + } + } + }, + "ServiceReplicaDescription": { + "description": "Describes a replica of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + } + ], + "properties": { + "replicaName": { + "type": "string", + "description": "Name of the replica." + } + }, + "required": [ + "replicaName" + ] + }, + "AverageLoadScalingTrigger": { + "description": "Describes the average load trigger used for auto scaling.", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingTrigger" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AverageLoad", + "properties": { + "metric": { + "$ref": "#/definitions/AutoScalingMetric", + "description": "Description of the metric that is used for scaling." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "Lower load threshold (if average load is below this threshold, service will scale down)." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "Upper load threshold (if average load is above this threshold, service will scale up)." + }, + "scaleIntervalInSeconds": { + "type": "integer", + "description": "Scale interval that indicates how often will this trigger be checked.", + "minimum": 60 + } + }, + "required": [ + "metric", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleIntervalInSeconds" + ] + }, + "ServiceResourceProperties": { + "description": "This type describes properties of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "$ref": "#/definitions/ServiceProperties" + } + ] + }, + "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" + ] + }, + "ServiceResourceDescriptionList": { + "description": "A pageable list of service resources.", + "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." + } + } + }, + "ServiceReplicaDescriptionList": { + "description": "A pageable list of service replicas.", + "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." + } + } + }, + "ContainerLogs": { + "description": "Container logs.", + "properties": { + "content": { + "type": "string", + "description": "Container logs." + } + } + } + }, + "parameters": { + "CodePackageNameRequiredPathParam": { + "name": "codePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of code package of the service." + }, + "api-versionRequiredQueryParam": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-09-01-preview" + ], + "default": "2018-09-01-preview", + "description": "The version of the API. This parameter is required and its value must be `2018-09-01-preview`.", + "required": true, + "x-ms-enum": { + "name": "2018-09-01-preview", + "modelAsString": true, + "values": [ + { + "value": "2018-09-01-preview", + "description": "The `2018-09-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" + }, + "SecretResourceDescriptionRequiredBodyParam": { + "name": "secretResourceDescription", + "in": "body", + "description": "Description for creating a secret resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "SecretResourceNameRequiredPathParam": { + "name": "secretResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the secret resource." + }, + "SecretValueResourceDescriptionRequiredBodyParam": { + "name": "secretValueResourceDescription", + "in": "body", + "description": "Description for creating a value of a secret resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "SecretValueResourceNameRequiredPathParam": { + "name": "secretValueResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the secret resource value which is typically the version identifier for the value." + }, + "VolumeResourceDescriptionRequiredBodyParam": { + "name": "volumeResourceDescription", + "in": "body", + "description": "Description for creating a Volume resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "VolumeResourceNameRequiredPathParam": { + "name": "volumeResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the volume." + }, + "NetworkResourceDescriptionRequiredBodyParam": { + "name": "networkResourceDescription", + "in": "body", + "description": "Description for creating a Network resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "NetworkResourceNameRequiredPathParam": { + "name": "networkResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the network." + }, + "GatewayResourceDescriptionRequiredBodyParam": { + "name": "gatewayResourceDescription", + "in": "body", + "description": "Description for creating a Gateway resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "GatewayResourceNameRequiredPathParam": { + "name": "gatewayResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the gateway." + }, + "ApplicationResourceDescriptionRequiredBodyParam": { + "name": "applicationResourceDescription", + "in": "body", + "description": "Description for creating a Application resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "ApplicationResourceNameRequiredPathParam": { + "name": "applicationResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application." + }, + "ServiceResourceNameRequiredPathParam": { + "name": "serviceResourceName", + "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": "Service Fabric replica name." + }, + "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/servicefabricmesh/resource-manager/readme.md b/specification/servicefabricmesh/resource-manager/readme.md index 83efdb69f4b5..c217dd611e54 100644 --- a/specification/servicefabricmesh/resource-manager/readme.md +++ b/specification/servicefabricmesh/resource-manager/readme.md @@ -1,169 +1,169 @@ -# Service Fabric Mesh REST APIs - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Azure Service Fabric Mesh. - -Azure Service Fabric Mesh is fully managed service where developers can build and deploy mission critical applications without managing any infrastructure such as VMs, storage, or networking. Mesh is a serverless environment for applications built from microservices. - -[Azure Service Fabric](http://aka.ms/ServiceFabric) is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable microservices. - - ---- -## Getting Started -To build the SDK for ServiceFabricManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - -Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK. - -``` yaml -title: ServiceFabricMeshManagementClient -description: Service Fabric Mesh Management Client -openapi-type: arm -tag: package-2018-09-01-preview - -directive: - - suppress: RequiredPropertiesMissingInResourceModel - reason: Service is a proxy resource that is managed (created and updated) by including it in the application resource. The name is required by RP to manage those resources. The name is readOnly in the default resource schema so it is not serialized on the wire by AutoRest generated libraries. This is a bug on our RP and should be fixed. The inlined objects should be part of the application properties and not a separate proxy resource. - - suppress: EnumInsteadOfBoolean - reason: The `readOnly` boolean schema is part of Azure Resource Manager common schema. - - suppress: TrackedResourcePatchOperation - reason: The patch operation is not implemented in the preview APIs. -``` -### Tag: package-2018-09-01-preview - -These settings apply only when `--tag=package-2018-09-01-preview` is specified on the command line. - - -``` yaml $(tag) == 'package-2018-09-01-preview' -input-file: -- Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json -``` -### Tag: package-2018-07-01-preview - -These settings apply only when `--tag=package-2018-07-01-preview` is specified on the command line. - - -``` yaml $(tag) == 'package-2018-07-01-preview' -input-file: -- Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json -``` ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_fabric_mesh'] -``` - - -## C# -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.ServiceFabricMesh - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/ServiceFabric/Management.ServiceFabricMesh/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.servicefabricmesh - package-name: azure-mgmt-servicefabricmesh -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh/azure/mgmt/servicefabricmesh -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.servicefabricmesh -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabricmesh -``` -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-09-01-preview - - tag: package-2018-07-01-preview -``` - -### Tag: package-2018-09-01-preview and java - -These settings apply only when `--tag=2018-09-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == '2018-09-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.servicefabricmesh.v2018_09_01_preview - output-folder: $(azure-libraries-for-java-folder)/servicefabricmesh/resource-manager/v2018_09_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-07-01-preview and java - -These settings apply only when `--tag=2018-07-01-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == '2018-07-01-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.servicefabricmesh.v2018_07_01_preview - output-folder: $(azure-libraries-for-java-folder)/servicefabricmesh/resource-manager/v2018_07_01_preview -regenerate-manager: true -generate-interface: true -``` +# Service Fabric Mesh REST APIs + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Service Fabric Mesh. + +Azure Service Fabric Mesh is fully managed service where developers can build and deploy mission critical applications without managing any infrastructure such as VMs, storage, or networking. Mesh is a serverless environment for applications built from microservices. + +[Azure Service Fabric](http://aka.ms/ServiceFabric) is a distributed systems platform that makes it easy to package, deploy, and manage scalable and reliable microservices. + + +--- +## Getting Started +To build the SDK for ServiceFabricManagementClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +Following are the settings for using this specification with [AutoRest](https://aka.ms/autorest) tool to validation and optionally generate SDK. + +``` yaml +title: ServiceFabricMeshManagementClient +description: Service Fabric Mesh Management Client +openapi-type: arm +tag: package-2018-09-01-preview + +directive: + - suppress: RequiredPropertiesMissingInResourceModel + reason: Service is a proxy resource that is managed (created and updated) by including it in the application resource. The name is required by RP to manage those resources. The name is readOnly in the default resource schema so it is not serialized on the wire by AutoRest generated libraries. This is a bug on our RP and should be fixed. The inlined objects should be part of the application properties and not a separate proxy resource. + - suppress: EnumInsteadOfBoolean + reason: The `readOnly` boolean schema is part of Azure Resource Manager common schema. + - suppress: TrackedResourcePatchOperation + reason: The patch operation is not implemented in the preview APIs. +``` +### Tag: package-2018-09-01-preview + +These settings apply only when `--tag=package-2018-09-01-preview` is specified on the command line. + + +``` yaml $(tag) == 'package-2018-09-01-preview' +input-file: +- Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json +``` +### Tag: package-2018-07-01-preview + +These settings apply only when `--tag=package-2018-07-01-preview` is specified on the command line. + + +``` yaml $(tag) == 'package-2018-07-01-preview' +input-file: +- Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json +``` +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_service_fabric_mesh'] +``` + + +## C# +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.ServiceFabricMesh + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/ServiceFabric/Management.ServiceFabricMesh/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.servicefabricmesh + package-name: azure-mgmt-servicefabricmesh +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh/azure/mgmt/servicefabricmesh +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-servicefabricmesh +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.servicefabricmesh +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabricmesh +``` +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09-01-preview + - tag: package-2018-07-01-preview +``` + +### Tag: package-2018-09-01-preview and java + +These settings apply only when `--tag=2018-09-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == '2018-09-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabricmesh.v2018_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicefabricmesh/resource-manager/v2018_09_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-07-01-preview and java + +These settings apply only when `--tag=2018-07-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == '2018-07-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabricmesh.v2018_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicefabricmesh/resource-manager/v2018_07_01_preview +regenerate-manager: true +generate-interface: true +``` 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/GetRestorableDroppedManagedDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetRestorableDroppedManagedDatabase.json index fab7b04f7d0a..3c68f0f2d4e8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetRestorableDroppedManagedDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetRestorableDroppedManagedDatabase.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Test1", - "managedInstanceName": "managedInstance", - "restorableDroppedDatabaseId": "testdb,131403269876900000", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "databaseName": "testdb", - "creationDate": "2017-05-07T04:41:33.937Z", - "deletionDate": "2017-05-27T02:49:47.690Z" - }, - "location": "southeastasia", - "id": - "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/restorableDroppedDatabases/testdb,131403269876900000", - "name": "testdb,131403269876900000", - "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases" - } - } - } -} +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "restorableDroppedDatabaseId": "testdb,131403269876900000", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "databaseName": "testdb", + "creationDate": "2017-05-07T04:41:33.937Z", + "deletionDate": "2017-05-27T02:49:47.690Z" + }, + "location": "southeastasia", + "id": + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/restorableDroppedDatabases/testdb,131403269876900000", + "name": "testdb,131403269876900000", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases" + } + } + } +} 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..5bf419988952 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 0122980b97b3..a2a864789a16 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,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "resourceGroup", - "serverName": "testserver", - "databaseName": "testDatabase", - "policyName" : "default", - "api-version": "2017-03-01", - "parameters": { - "properties" : { - "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": { + "properties" : { + "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/RestorableDroppedManagedDatabaseListByManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/RestorableDroppedManagedDatabaseListByManagedInstance.json index abd7cdc1a910..eede52de3e56 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/RestorableDroppedManagedDatabaseListByManagedInstance.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/RestorableDroppedManagedDatabaseListByManagedInstance.json @@ -1,38 +1,38 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "Test1", - "managedInstanceName": "managedInstance", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "databaseName": "testdb", - "creationDate": "2017-05-07T04:41:33.937Z", - "deletionDate": "2017-05-27T02:49:47.690Z" - }, - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/restorableDroppedDatabases/testdb,131403269876900000", - "name": "testdb,131403269876900000", - "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases" - }, - { - "properties": { - "databaseName": "testdb2", - "creationDate": "2017-05-07T04:41:33.937Z", - "deletionDate": "2017-05-27T02:49:47.690Z" - }, - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/restorableDroppedDatabases/testdb2,131403269876900000", - "name": "testdb2,131403269876900000", - "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases" - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "databaseName": "testdb", + "creationDate": "2017-05-07T04:41:33.937Z", + "deletionDate": "2017-05-27T02:49:47.690Z" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/restorableDroppedDatabases/testdb,131403269876900000", + "name": "testdb,131403269876900000", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases" + }, + { + "properties": { + "databaseName": "testdb2", + "creationDate": "2017-05-07T04:41:33.937Z", + "deletionDate": "2017-05-27T02:49:47.690Z" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/restorableDroppedDatabases/testdb2,131403269876900000", + "name": "testdb2,131403269876900000", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases" + } + ] + } + } + } } \ No newline at end of file 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 561f3606487d..c120d0466cf0 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,715 +1,715 @@ -{ - "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", - "description": "The name of the server", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionDatabaseName", - "in": "path", - "description": "The name of the database", - "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", - "description": "The name of the server", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionDatabaseName", - "in": "path", - "description": "The name of the database", - "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", - "description": "The name of the server", - "required": true, - "type": "string" - }, - { - "name": "longTermRetentionDatabaseName", - "in": "path", - "description": "The name 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 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", - "description": "The name of the server", - "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 backups.", - "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 monthly 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", + "description": "The name of the server", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionDatabaseName", + "in": "path", + "description": "The name of the database", + "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", + "description": "The name of the server", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionDatabaseName", + "in": "path", + "description": "The name of the database", + "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", + "description": "The name of the server", + "required": true, + "type": "string" + }, + { + "name": "longTermRetentionDatabaseName", + "in": "path", + "description": "The name 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 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", + "description": "The name of the server", + "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 backups.", + "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 monthly 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/restorableDroppedManagedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json index 99b561a419fd..ecfbd76e9214 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json @@ -1,323 +1,323 @@ -{ - "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/managedInstances/{managedInstanceName}/restorableDroppedDatabases": { - "get": { - "tags": [ - "RestorableDroppedManagedDatabases" - ], - "description": "Gets a list of restorable dropped managed databases.", - "operationId": "RestorableDroppedManagedDatabases_ListByInstance", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of restorable dropped databases.", - "schema": { - "$ref": "#/definitions/RestorableDroppedManagedDatabaseListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List restorable dropped databases by managed instances": { - "$ref": "./examples/RestorableDroppedManagedDatabaseListByManagedInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}": { - "get": { - "tags": [ - "RestorableDroppedManagedDatabases" - ], - "description": "Gets a restorable dropped managed database.", - "operationId": "RestorableDroppedManagedDatabases_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "restorableDroppedDatabaseId", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the specified restorable dropped database.", - "schema": { - "$ref": "#/definitions/RestorableDroppedManagedDatabase" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." - } - }, - "x-ms-examples": { - "Gets a restorable dropped managed database.": { - "$ref": "./examples/GetRestorableDroppedManagedDatabase.json" - } - } - } - } - }, - "definitions": { - "RestorableDroppedManagedDatabaseListResult": { - "description": "A list of restorable dropped managed databases.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/RestorableDroppedManagedDatabase" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "RestorableDroppedManagedDatabaseProperties": { - "description": "The restorable dropped managed database's properties.", - "type": "object", - "properties": { - "databaseName": { - "description": "The name of the database.", - "type": "string", - "readOnly": true - }, - "creationDate": { - "format": "date-time", - "description": "The creation date of the database (ISO8601 format).", - "type": "string", - "readOnly": true - }, - "deletionDate": { - "format": "date-time", - "description": "The deletion date of the database (ISO8601 format).", - "type": "string", - "readOnly": true - }, - "earliestRestoreDate": { - "format": "date-time", - "description": "The earliest restore date of the database (ISO8601 format).", - "type": "string", - "readOnly": true - } - } - }, - "Resource": { - "description": "ARM resource.", - "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 - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked top level resource.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Resource location.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "RestorableDroppedManagedDatabase": { - "description": "A restorable dropped managed database resource.", - "required": [ - "location" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/RestorableDroppedManagedDatabaseProperties", - "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-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/managedInstances/{managedInstanceName}/restorableDroppedDatabases": { + "get": { + "tags": [ + "RestorableDroppedManagedDatabases" + ], + "description": "Gets a list of restorable dropped managed databases.", + "operationId": "RestorableDroppedManagedDatabases_ListByInstance", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of restorable dropped databases.", + "schema": { + "$ref": "#/definitions/RestorableDroppedManagedDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List restorable dropped databases by managed instances": { + "$ref": "./examples/RestorableDroppedManagedDatabaseListByManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}": { + "get": { + "tags": [ + "RestorableDroppedManagedDatabases" + ], + "description": "Gets a restorable dropped managed database.", + "operationId": "RestorableDroppedManagedDatabases_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "restorableDroppedDatabaseId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified restorable dropped database.", + "schema": { + "$ref": "#/definitions/RestorableDroppedManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Gets a restorable dropped managed database.": { + "$ref": "./examples/GetRestorableDroppedManagedDatabase.json" + } + } + } + } + }, + "definitions": { + "RestorableDroppedManagedDatabaseListResult": { + "description": "A list of restorable dropped managed databases.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/RestorableDroppedManagedDatabase" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "RestorableDroppedManagedDatabaseProperties": { + "description": "The restorable dropped managed database's properties.", + "type": "object", + "properties": { + "databaseName": { + "description": "The name of the database.", + "type": "string", + "readOnly": true + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the database (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "deletionDate": { + "format": "date-time", + "description": "The deletion date of the database (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "earliestRestoreDate": { + "format": "date-time", + "description": "The earliest restore date of the database (ISO8601 format).", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "ARM resource.", + "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 + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked top level resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "RestorableDroppedManagedDatabase": { + "description": "A restorable dropped managed database resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RestorableDroppedManagedDatabaseProperties", + "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-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/ManagedInstanceEncryptionProtectors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json index 03d67c78377b..9146c4594679 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json @@ -1,355 +1,355 @@ -{ - "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}/encryptionProtector": { - "get": { - "tags": [ - "ManagedInstanceEncryptionProtectors" - ], - "description": "Gets a list of managed instance encryption protectors", - "operationId": "ManagedInstanceEncryptionProtectors_ListByInstance", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of managed instance encryption protector.", - "schema": { - "$ref": "#/definitions/ManagedInstanceEncryptionProtectorListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List encryption protectors by managed instance": { - "$ref": "./examples/ManagedInstanceEncryptionProtectorList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/{encryptionProtectorName}": { - "get": { - "tags": [ - "ManagedInstanceEncryptionProtectors" - ], - "description": "Gets a managed instance encryption protector.", - "operationId": "ManagedInstanceEncryptionProtectors_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "encryptionProtectorName", - "in": "path", - "description": "The name of the encryption protector to be retrieved.", - "required": true, - "type": "string", - "enum": [ - "current" - ], - "x-ms-enum": { - "name": "EncryptionProtectorName", - "modelAsString": true - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the specified managed instance encryption protector.", - "schema": { - "$ref": "#/definitions/ManagedInstanceEncryptionProtector" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\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 encryption protector": { - "$ref": "./examples/ManagedInstanceEncryptionProtectorGet.json" - } - } - }, - "put": { - "tags": [ - "ManagedInstanceEncryptionProtectors" - ], - "description": "Updates an existing encryption protector.", - "operationId": "ManagedInstanceEncryptionProtectors_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "encryptionProtectorName", - "in": "path", - "description": "The name of the encryption protector to be created or updated.", - "required": true, - "type": "string", - "enum": [ - "current" - ], - "x-ms-enum": { - "name": "EncryptionProtectorName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "description": "The requested encryption protector resource state.", - "required": true, - "schema": { - "$ref": "#/definitions/ManagedInstanceEncryptionProtector" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the encryption protector.", - "schema": { - "$ref": "#/definitions/ManagedInstanceEncryptionProtector" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update the encryption protector to key vault": { - "$ref": "./examples/ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json" - }, - "Update the encryption protector to service managed": { - "$ref": "./examples/ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json" - } - } - } - } - }, - "definitions": { - "ManagedInstanceEncryptionProtectorListResult": { - "description": "A list of managed instance encryption protectors.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedInstanceEncryptionProtector" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "ManagedInstanceEncryptionProtectorProperties": { - "description": "Properties for an encryption protector execution.", - "required": [ - "serverKeyType" - ], - "type": "object", - "properties": { - "serverKeyName": { - "description": "The name of the managed instance key.", - "type": "string" - }, - "serverKeyType": { - "description": "The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.", - "enum": [ - "ServiceManaged", - "AzureKeyVault" - ], - "type": "string", - "x-ms-enum": { - "name": "ServerKeyType", - "modelAsString": true - } - }, - "uri": { - "description": "The URI of the server key.", - "type": "string", - "readOnly": true - }, - "thumbprint": { - "description": "Thumbprint of the server key.", - "type": "string", - "readOnly": true - } - } - }, - "ManagedInstanceEncryptionProtector": { - "description": "The managed instance encryption protector.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "kind": { - "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", - "type": "string", - "readOnly": true - }, - "properties": { - "$ref": "#/definitions/ManagedInstanceEncryptionProtectorProperties", - "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}/encryptionProtector": { + "get": { + "tags": [ + "ManagedInstanceEncryptionProtectors" + ], + "description": "Gets a list of managed instance encryption protectors", + "operationId": "ManagedInstanceEncryptionProtectors_ListByInstance", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed instance encryption protector.", + "schema": { + "$ref": "#/definitions/ManagedInstanceEncryptionProtectorListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List encryption protectors by managed instance": { + "$ref": "./examples/ManagedInstanceEncryptionProtectorList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/{encryptionProtectorName}": { + "get": { + "tags": [ + "ManagedInstanceEncryptionProtectors" + ], + "description": "Gets a managed instance encryption protector.", + "operationId": "ManagedInstanceEncryptionProtectors_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector to be retrieved.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified managed instance encryption protector.", + "schema": { + "$ref": "#/definitions/ManagedInstanceEncryptionProtector" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\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 encryption protector": { + "$ref": "./examples/ManagedInstanceEncryptionProtectorGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedInstanceEncryptionProtectors" + ], + "description": "Updates an existing encryption protector.", + "operationId": "ManagedInstanceEncryptionProtectors_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "encryptionProtectorName", + "in": "path", + "description": "The name of the encryption protector to be created or updated.", + "required": true, + "type": "string", + "enum": [ + "current" + ], + "x-ms-enum": { + "name": "EncryptionProtectorName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The requested encryption protector resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedInstanceEncryptionProtector" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the encryption protector.", + "schema": { + "$ref": "#/definitions/ManagedInstanceEncryptionProtector" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the encryption protector to key vault": { + "$ref": "./examples/ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json" + }, + "Update the encryption protector to service managed": { + "$ref": "./examples/ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json" + } + } + } + } + }, + "definitions": { + "ManagedInstanceEncryptionProtectorListResult": { + "description": "A list of managed instance encryption protectors.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedInstanceEncryptionProtector" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedInstanceEncryptionProtectorProperties": { + "description": "Properties for an encryption protector execution.", + "required": [ + "serverKeyType" + ], + "type": "object", + "properties": { + "serverKeyName": { + "description": "The name of the managed instance key.", + "type": "string" + }, + "serverKeyType": { + "description": "The encryption protector type like 'ServiceManaged', 'AzureKeyVault'.", + "enum": [ + "ServiceManaged", + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerKeyType", + "modelAsString": true + } + }, + "uri": { + "description": "The URI of the server key.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Thumbprint of the server key.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedInstanceEncryptionProtector": { + "description": "The managed instance encryption protector.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ManagedInstanceEncryptionProtectorProperties", + "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/ManagedInstanceKeys.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json index 0b474de914ca..d3c06b106570 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json @@ -1,406 +1,406 @@ -{ - "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}/keys": { - "get": { - "tags": [ - "ManagedInstanceKeys" - ], - "description": "Gets a list of managed instance keys.", - "operationId": "ManagedInstanceKeys_ListByInstance", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "An OData filter expression that filters elements in the collection.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the list of managed instance keys.", - "schema": { - "$ref": "#/definitions/ManagedInstanceKeyListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List the keys for a managed instance.": { - "$ref": "./examples/ManagedInstanceKeyList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}": { - "get": { - "tags": [ - "ManagedInstanceKeys" - ], - "description": "Gets a managed instance key.", - "operationId": "ManagedInstanceKeys_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "keyName", - "in": "path", - "description": "The name of the managed instance key to be retrieved.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the specified managed instance key.", - "schema": { - "$ref": "#/definitions/ManagedInstanceKey" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\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 managed instance key": { - "$ref": "./examples/ManagedInstanceKeyGet.json" - } - } - }, - "put": { - "tags": [ - "ManagedInstanceKeys" - ], - "description": "Creates or updates a managed instance key.", - "operationId": "ManagedInstanceKeys_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "keyName", - "in": "path", - "description": "The name of the managed instance key to be operated on (updated or created).", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "The requested managed instance key resource state.", - "required": true, - "schema": { - "$ref": "#/definitions/ManagedInstanceKey" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the managed instance key.", - "schema": { - "$ref": "#/definitions/ManagedInstanceKey" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." - }, - "202": { - "description": "Accepted" - }, - "201": { - "description": "Successfully created the managed instance key.", - "schema": { - "$ref": "#/definitions/ManagedInstanceKey" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Creates or updates a managed instance key": { - "$ref": "./examples/ManagedInstanceKeyCreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "ManagedInstanceKeys" - ], - "description": "Deletes the managed instance key with the given name.", - "operationId": "ManagedInstanceKeys_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ManagedInstanceNameParameter" - }, - { - "name": "keyName", - "in": "path", - "description": "The name of the managed instance key to be deleted.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the managed instance key." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "The specified managed instance key does not exist." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Delete the managed instance key": { - "$ref": "./examples/ManagedInstanceKeyDelete.json" - } - } - } - } - }, - "definitions": { - "ManagedInstanceKeyListResult": { - "description": "A list of managed instance keys.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedInstanceKey" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "ManagedInstanceKeyProperties": { - "description": "Properties for a key execution.", - "required": [ - "serverKeyType" - ], - "type": "object", - "properties": { - "serverKeyType": { - "description": "The key type like 'ServiceManaged', 'AzureKeyVault'.", - "enum": [ - "ServiceManaged", - "AzureKeyVault" - ], - "type": "string", - "x-ms-enum": { - "name": "ServerKeyType", - "modelAsString": true - }, - "x-ms-mutability": [ - "create" - ] - }, - "uri": { - "description": "The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.", - "type": "string", - "x-ms-mutability": [ - "create" - ] - }, - "thumbprint": { - "description": "Thumbprint of the key.", - "type": "string", - "readOnly": true - }, - "creationDate": { - "format": "date-time", - "description": "The key creation date.", - "type": "string", - "readOnly": true - } - } - }, - "ManagedInstanceKey": { - "description": "A managed instance key.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "kind": { - "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", - "type": "string", - "readOnly": true - }, - "properties": { - "$ref": "#/definitions/ManagedInstanceKeyProperties", - "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}/keys": { + "get": { + "tags": [ + "ManagedInstanceKeys" + ], + "description": "Gets a list of managed instance keys.", + "operationId": "ManagedInstanceKeys_ListByInstance", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData filter expression that filters elements in the collection.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of managed instance keys.", + "schema": { + "$ref": "#/definitions/ManagedInstanceKeyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the keys for a managed instance.": { + "$ref": "./examples/ManagedInstanceKeyList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}": { + "get": { + "tags": [ + "ManagedInstanceKeys" + ], + "description": "Gets a managed instance key.", + "operationId": "ManagedInstanceKeys_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the managed instance key to be retrieved.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified managed instance key.", + "schema": { + "$ref": "#/definitions/ManagedInstanceKey" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\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 managed instance key": { + "$ref": "./examples/ManagedInstanceKeyGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedInstanceKeys" + ], + "description": "Creates or updates a managed instance key.", + "operationId": "ManagedInstanceKeys_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the managed instance key to be operated on (updated or created).", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested managed instance key resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedInstanceKey" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the managed instance key.", + "schema": { + "$ref": "#/definitions/ManagedInstanceKey" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created the managed instance key.", + "schema": { + "$ref": "#/definitions/ManagedInstanceKey" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates a managed instance key": { + "$ref": "./examples/ManagedInstanceKeyCreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ManagedInstanceKeys" + ], + "description": "Deletes the managed instance key with the given name.", + "operationId": "ManagedInstanceKeys_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the managed instance key to be deleted.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the managed instance key." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "The specified managed instance key does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete the managed instance key": { + "$ref": "./examples/ManagedInstanceKeyDelete.json" + } + } + } + } + }, + "definitions": { + "ManagedInstanceKeyListResult": { + "description": "A list of managed instance keys.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedInstanceKey" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedInstanceKeyProperties": { + "description": "Properties for a key execution.", + "required": [ + "serverKeyType" + ], + "type": "object", + "properties": { + "serverKeyType": { + "description": "The key type like 'ServiceManaged', 'AzureKeyVault'.", + "enum": [ + "ServiceManaged", + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerKeyType", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "uri": { + "description": "The URI of the key. If the ServerKeyType is AzureKeyVault, then the URI is required.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "thumbprint": { + "description": "Thumbprint of the key.", + "type": "string", + "readOnly": true + }, + "creationDate": { + "format": "date-time", + "description": "The key creation date.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedInstanceKey": { + "description": "A managed instance key.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "kind": { + "description": "Kind of encryption protector. This is metadata used for the Azure portal experience.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/ManagedInstanceKeyProperties", + "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/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..37394432791e 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/ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json index 984155d7fb1b..69d7a47c1af8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorCreateOrUpdateKeyVault.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "encryptionProtectorName": "current", - "api-version": "2017-10-01-preview", - "parameters": { - "properties": { - "serverKeyType": "AzureKeyVault", - "serverKeyName": "someVault_someKey_01234567890123456789012345678901" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/encryptionProtector", - "kind": "azurekeyvault", - "properties": { - "serverKeyName": "someVault_someKey_01234567890123456789012345678901", - "serverKeyType": "AzureKeyVault" - } - } - }, - "202": { } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "encryptionProtectorName": "current", + "api-version": "2017-10-01-preview", + "parameters": { + "properties": { + "serverKeyType": "AzureKeyVault", + "serverKeyName": "someVault_someKey_01234567890123456789012345678901" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/encryptionProtector", + "kind": "azurekeyvault", + "properties": { + "serverKeyName": "someVault_someKey_01234567890123456789012345678901", + "serverKeyType": "AzureKeyVault" + } + } + }, + "202": { } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json index 3dd36645faeb..d9cd27a2ed2b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorCreateOrUpdateServiceManaged.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "encryptionProtectorName": "current", - "api-version": "2017-10-01-preview", - "parameters": { - "properties": { - "serverKeyType": "ServiceManaged", - "serverKeyName": "ServiceManaged" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/encryptionProtector", - "kind": "servicemanaged", - "properties": { - "serverKeyName": "ServiceManaged", - "serverKeyType": "ServiceManaged" - } - } - }, - "202": { } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "encryptionProtectorName": "current", + "api-version": "2017-10-01-preview", + "parameters": { + "properties": { + "serverKeyType": "ServiceManaged", + "serverKeyName": "ServiceManaged" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/encryptionProtector", + "kind": "servicemanaged", + "properties": { + "serverKeyName": "ServiceManaged", + "serverKeyType": "ServiceManaged" + } + } + }, + "202": { } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorGet.json index a3aa8fa45591..55f142d6b549 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorGet.json @@ -1,24 +1,24 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "encryptionProtectorName": "current", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/encryptionProtector", - "kind": "azurekeyvault", - "properties": { - "serverKeyName": "someVault_someKey_01234567890123456789012345678901", - "serverKeyType": "AzureKeyVault", - "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "encryptionProtectorName": "current", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/encryptionProtector", + "kind": "azurekeyvault", + "properties": { + "serverKeyName": "someVault_someKey_01234567890123456789012345678901", + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" + } + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorList.json index ddb7e0ea4e69..c4b7cdce93d7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorList.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceEncryptionProtectorList.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", - "name": "current", - "type": "Microsoft.Sql/managedInstances/encryptionProtector", - "kind": "azurekeyvault", - "properties": { - "serverKeyName": "someVault_someKey_01234567890123456789012345678901", - "serverKeyType": "AzureKeyVault", - "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/encryptionProtector/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/encryptionProtector", + "kind": "azurekeyvault", + "properties": { + "serverKeyName": "someVault_someKey_01234567890123456789012345678901", + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" + } + } + ] + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyCreateOrUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyCreateOrUpdate.json index e7e6d7ee2db9..1be1b7cee0d5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyCreateOrUpdate.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyCreateOrUpdate.json @@ -1,46 +1,46 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "keyName": "someVault_someKey_01234567890123456789012345678901", - "api-version": "2017-10-01-preview", - "parameters": { - "properties": { - "serverKeyType": "AzureKeyVault", - "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", - "name": "sqlcrudtest-4645", - "type": "Microsoft.Sql/managedInstances/keys", - "kind": "azurekeyvault", - "properties": { - "serverKeyType": "AzureKeyVault", - "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", - "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", - "creationDate": "2017-05-01T00:00:00.0Z" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", - "name": "sqlcrudtest-4645", - "type": "Microsoft.Sql/managedInstances/keys", - "kind": "azurekeyvault", - "properties": { - "serverKeyType": "AzureKeyVault", - "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", - "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", - "creationDate": "2017-05-01T00:00:00.0Z" - } - } - }, - "202": { } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2017-10-01-preview", + "parameters": { + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", + "name": "sqlcrudtest-4645", + "type": "Microsoft.Sql/managedInstances/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", + "creationDate": "2017-05-01T00:00:00.0Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", + "name": "sqlcrudtest-4645", + "type": "Microsoft.Sql/managedInstances/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", + "creationDate": "2017-05-01T00:00:00.0Z" + } + } + }, + "202": { } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyDelete.json index 89f371d55ebf..d4364ec4dd72 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyDelete.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyDelete.json @@ -1,18 +1,18 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "keyName": "someVault_someKey_01234567890123456789012345678901", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": "" - }, - "202": {}, - "204": { - "body": "" - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": {}, + "204": { + "body": "" + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyGet.json index 10180e4dae9d..24f4871074d1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyGet.json @@ -1,25 +1,25 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "keyName": "someVault_someKey_01234567890123456789012345678901", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", - "name": "sqlcrudtest-4645", - "type": "Microsoft.Sql/managedInstances/keys", - "kind": "azurekeyvault", - "properties": { - "serverKeyType": "AzureKeyVault", - "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", - "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", - "creationDate": "2017-05-01T00:00:00.0Z" - } - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "keyName": "someVault_someKey_01234567890123456789012345678901", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", + "name": "sqlcrudtest-4645", + "type": "Microsoft.Sql/managedInstances/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", + "creationDate": "2017-05-01T00:00:00.0Z" + } + } + } + } } \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyList.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyList.json index eec51cfeb0d6..04314f0fe719 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyList.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedInstanceKeyList.json @@ -1,49 +1,49 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "sqlcrudtest-7398", - "managedInstanceName": "sqlcrudtest-4645", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", - "name": "someVault_someKey_01234567890123456789012345678901", - "type": "Microsoft.Sql/managedInstances/keys", - "kind": "azurekeyvault", - "properties": { - "serverKeyType": "AzureKeyVault", - "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", - "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", - "creationDate": "2017-05-01T00:00:00.0Z" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111", - "name": "myVault_myKey_11111111111111111111111111111111", - "type": "Microsoft.Sql/managedInstances/keys", - "kind": "azurekeyvault", - "properties": { - "serverKeyType": "AzureKeyVault", - "uri": "https://myVault.vault.azure.net/keys/myKey/11111111111111111111111111111111", - "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB", - "creationDate": "2017-05-01T00:00:00.0Z" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/ServiceManaged", - "name": "ServiceManaged", - "type": "Microsoft.Sql/managedInstances/keys", - "kind": "servicemanaged", - "properties": { - "serverKeyType": "ServiceManaged" - } - } - ] - } - } - } +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "sqlcrudtest-7398", + "managedInstanceName": "sqlcrudtest-4645", + "api-version": "2017-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901", + "name": "someVault_someKey_01234567890123456789012345678901", + "type": "Microsoft.Sql/managedInstances/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901", + "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD", + "creationDate": "2017-05-01T00:00:00.0Z" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111", + "name": "myVault_myKey_11111111111111111111111111111111", + "type": "Microsoft.Sql/managedInstances/keys", + "kind": "azurekeyvault", + "properties": { + "serverKeyType": "AzureKeyVault", + "uri": "https://myVault.vault.azure.net/keys/myKey/11111111111111111111111111111111", + "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB", + "creationDate": "2017-05-01T00:00:00.0Z" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/ServiceManaged", + "name": "ServiceManaged", + "type": "Microsoft.Sql/managedInstances/keys", + "kind": "servicemanaged", + "properties": { + "serverKeyType": "ServiceManaged" + } + } + ] + } + } + } } \ 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..a2560ef0e9cf 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/readme.md b/specification/sql/resource-manager/readme.md index 57bde08929f0..818f80f5dd3b 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -1,704 +1,704 @@ -# Sql - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Sql. - -## Getting Started - -To build the SDK for Sql, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - -## Configuration - -### Basic Information - -These are the global settings for the Sql API. - -``` yaml -title: SqlManagementClient -description: The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases. -openapi-type: arm -tag: package-composite-v3 -``` - -## Composite packages - -The following packages may be composed from multiple api-versions. - -### Tag: package-composite-v3 - -These settings apply only when `--tag=package-composite-v3` is specified on the command line. - -This section contains the "composite-v3" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v3" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.14.0-preview. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - - -Differences in v3 (compared to v2): - - Decoupled database and recommended elastic pool APIs - - `-2014-04-01/recommendedElasticPools.json` - - `+2014-04-01/recommendedElasticPoolsDecoupled.json` - - Updated to new Sku-based API for databases and elastic pools - - `-2014-04-01/capabilities.json` - - `-2014-04-01/databases.json` - - `-2014-04-01/elasticPools.json` - - `+2017-10-01-preview/capabilities.json` - - `+2017-10-01-preview/databases.json` - - `+2017-10-01-preview/elasticPools.json` - -``` yaml $(tag) == 'package-composite-v3' -input-file: -- Microsoft.Sql/stable/2014-04-01/backups.json -- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json -- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json -- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json -- Microsoft.Sql/stable/2014-04-01/dataMasking.json -- Microsoft.Sql/stable/2014-04-01/firewallRules.json -- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json -- Microsoft.Sql/stable/2014-04-01/importExport.json -- Microsoft.Sql/stable/2014-04-01/metrics.json -- Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json -- Microsoft.Sql/stable/2014-04-01/replicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json -- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json -- Microsoft.Sql/stable/2014-04-01/sql.core.json -- Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json -- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json -- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json -- Microsoft.Sql/preview/2015-05-01-preview/operations.json -- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json -- Microsoft.Sql/preview/2015-05-01-preview/servers.json -- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json -- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json -- Microsoft.Sql/preview/2015-05-01-preview/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json -- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json -- Microsoft.Sql/preview/2017-03-01-preview/jobs.json -- Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json -- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json -- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json -- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json -- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json -- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json -- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json -- Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json -- Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json -- Microsoft.Sql/preview/2017-10-01-preview/capabilities.json -- Microsoft.Sql/preview/2017-10-01-preview/databases.json -- Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json -- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json -- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json -- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json -- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json -- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json -- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json -- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json -- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-composite-v2 - -These settings apply only when `--tag=package-composite-v2` is specified on the command line. - -This section contains the "composite-v2" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v2" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.13.0-preview. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -Differences in v2 (compared to v1): - -- Updated to LTRv2 - - `-201 4-04-01/backupLongTermRetentionPolicies.json` - - `-2014-04-01/backupLongTermRetentionVaults.json` - - `+2017-03-01-preview/longTermRetention.json` - -``` yaml $(tag) == 'package-composite-v2' -input-file: -- Microsoft.Sql/stable/2014-04-01/backups.json -- Microsoft.Sql/stable/2014-04-01/capabilities.json -- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json -- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json -- Microsoft.Sql/stable/2014-04-01/databases.json -- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json -- Microsoft.Sql/stable/2014-04-01/dataMasking.json -- Microsoft.Sql/stable/2014-04-01/elasticPools.json -- Microsoft.Sql/stable/2014-04-01/firewallRules.json -- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json -- Microsoft.Sql/stable/2014-04-01/importExport.json -- Microsoft.Sql/stable/2014-04-01/metrics.json -- Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json -- Microsoft.Sql/stable/2014-04-01/replicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json -- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json -- Microsoft.Sql/stable/2014-04-01/sql.core.json -- Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json -- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json -- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json -- Microsoft.Sql/preview/2015-05-01-preview/operations.json -- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json -- Microsoft.Sql/preview/2015-05-01-preview/servers.json -- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json -- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json -- Microsoft.Sql/preview/2015-05-01-preview/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json -- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json -- Microsoft.Sql/preview/2017-03-01-preview/jobs.json -- Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json -- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json -- Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json -- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json -- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json -- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json -- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json -- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json -- Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json -- Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json -- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json -- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json -- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json -- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json -- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json -- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json -- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json -- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-composite-v1 - -These settings apply only when `--tag=package-composite-v1` is specified on the command line. - -This section contains the "composite-v1" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v1" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.12.0-preview and earlier. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -``` yaml $(tag) == 'package-composite-v1' -input-file: -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json -- Microsoft.Sql/stable/2014-04-01/backups.json -- Microsoft.Sql/stable/2014-04-01/capabilities.json -- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json -- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json -- Microsoft.Sql/stable/2014-04-01/databases.json -- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json -- Microsoft.Sql/stable/2014-04-01/dataMasking.json -- Microsoft.Sql/stable/2014-04-01/elasticPools.json -- Microsoft.Sql/stable/2014-04-01/firewallRules.json -- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json -- Microsoft.Sql/stable/2014-04-01/importExport.json -- Microsoft.Sql/stable/2014-04-01/metrics.json -- Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json -- Microsoft.Sql/stable/2014-04-01/replicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json -- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json -- Microsoft.Sql/stable/2014-04-01/sql.core.json -- Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json -- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json -- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json -- Microsoft.Sql/preview/2015-05-01-preview/operations.json -- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json -- Microsoft.Sql/preview/2015-05-01-preview/servers.json -- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json -- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json -- Microsoft.Sql/preview/2015-05-01-preview/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json -- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json -- Microsoft.Sql/preview/2017-03-01-preview/jobs.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json -- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json -- Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json -- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json -- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json -- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json -- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json -- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json -- Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json -- Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json -- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json -- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json -- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json -- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json -- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json -- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json -- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json -- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json -- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json -- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-2017-03-preview - -These settings apply only when `--tag=package-2017-03-preview` is specified on the command line. - -This section contains the input swagger files that are used when generating client SDKs up to and including api-version 2017-03-01-preview, except databases.json which remains at api-version 2014-04-01 in order to maintain compatibility with clients that have been previously released with this package. To prevent similar confusion moving forward, sections named like `package-20xx-xx(-preview)` will not be used after package-2017-03-preview. Instead, sections named like `package-composite-vx` will be used to compose across api-versions and `package-pure-20xx-xx(-preview)` will be used for single api-versions. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -``` yaml $(tag) == 'package-2017-03-preview' -input-file: -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json -- Microsoft.Sql/stable/2014-04-01/backups.json -- Microsoft.Sql/stable/2014-04-01/capabilities.json -- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json -- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json -- Microsoft.Sql/stable/2014-04-01/databases.json -- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json -- Microsoft.Sql/stable/2014-04-01/dataMasking.json -- Microsoft.Sql/stable/2014-04-01/elasticPools.json -- Microsoft.Sql/stable/2014-04-01/firewallRules.json -- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json -- Microsoft.Sql/stable/2014-04-01/importExport.json -- Microsoft.Sql/stable/2014-04-01/metrics.json -- Microsoft.Sql/stable/2014-04-01/replicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json -- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json -- Microsoft.Sql/stable/2014-04-01/sql.core.json -- Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json -- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json -- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json -- Microsoft.Sql/preview/2015-05-01-preview/operations.json -- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json -- Microsoft.Sql/preview/2015-05-01-preview/servers.json -- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json -- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json -- Microsoft.Sql/preview/2015-05-01-preview/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json -- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json -- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json -- Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json -- Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json -- Microsoft.Sql/preview/2017-03-01-preview/jobs.json -- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json -- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json -- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json -- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json -- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json -- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json -- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json -- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-2015-05-preview - -These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. - -This section contains the input swagger files that are used when generating client SDKs up to and including api-version 2015-05-01-preview. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -``` yaml $(tag) == 'package-2015-05-preview' -input-file: -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json -- Microsoft.Sql/stable/2014-04-01/backups.json -- Microsoft.Sql/stable/2014-04-01/restorePoints.json -- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json -- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json -- Microsoft.Sql/stable/2014-04-01/databases.json -- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json -- Microsoft.Sql/stable/2014-04-01/dataMasking.json -- Microsoft.Sql/stable/2014-04-01/elasticPools.json -- Microsoft.Sql/stable/2014-04-01/firewallRules.json -- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json -- Microsoft.Sql/stable/2014-04-01/importExport.json -- Microsoft.Sql/stable/2014-04-01/metrics.json -- Microsoft.Sql/stable/2014-04-01/replicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json -- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json -- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json -- Microsoft.Sql/stable/2014-04-01/sql.core.json -- Microsoft.Sql/stable/2014-04-01/usages.json -- Microsoft.Sql/stable/2015-05-01/capabilities.json -- Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json -- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json -- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json -- Microsoft.Sql/preview/2015-05-01-preview/operations.json -- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json -- Microsoft.Sql/preview/2015-05-01-preview/servers.json -- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json -- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json -- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json -- Microsoft.Sql/preview/2015-05-01-preview/usages.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json -- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-2014-04 - -These settings apply only when `--tag=package-2014-04` is specified on the command line. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -``` yaml $(tag) == 'package-2014-04' -input-file: -- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json -- Microsoft.Sql/stable/2014-04-01/databases.json -- Microsoft.Sql/stable/2014-04-01/elasticPools.json -- Microsoft.Sql/stable/2014-04-01/firewallRules.json -- Microsoft.Sql/stable/2014-04-01/importExport.json -- Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json -- Microsoft.Sql/stable/2014-04-01/replicationLinks.json -- Microsoft.Sql/stable/2014-04-01/sql.core.json -- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -## Pure package versions - -The following packages are each composed of all apis from only one api-version. - -### Tag: package-pure-2018-06-preview - -These settings apply only when `--tag=package-pure-2018-06-preview` is specified on the command line. - -This section contains all input swagger files for version 2018-06-01-preview. All APIs of that version must be added this section when the API is ready for production. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2018-06-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` - -``` yaml $(tag) == 'package-pure-2018-06-preview' -input-file: - - ./Microsoft.Sql/preview/2018-06-01-preview/DatabaseSecurityAlertPolicies.json - - ./Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json - - ./Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json - - ./Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient - ``` - -### Tag: package-pure-2017-10-preview - -These settings apply only when `--tag=package-pure-2017-10-preview` is specified on the command line. - -This section contains all input swagger files for version 2017-10-01-preview. All APIs of that version must be added this section when the API is ready for production. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-10-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` - -``` yaml $(tag) == 'package-pure-2017-10-preview' -input-file: - - ./Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - - ./Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - - ./Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json - - ./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json - - ./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json - - ./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json - - ./Microsoft.Sql/preview/2017-10-01-preview/capabilities.json - - ./Microsoft.Sql/preview/2017-10-01-preview/databases.json - - ./Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json - - ./Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json - - ./Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json - - ./Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json - - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json - - ./Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-pure-2017-03-preview - -These settings apply only when `--tag=package-pure-2017-03-preview` is specified on the command line. - -This section contains all input swagger files for version 2017-03-01-preview. All APIs of that version must be added this section when the API is ready for production. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-03-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` - -``` yaml $(tag) == 'package-pure-2017-03-preview' -input-file: - - ./Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json - - ./Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json - - ./Microsoft.Sql/preview/2017-03-01-preview/databases.json - - ./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json - - ./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json - - ./Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json - - ./Microsoft.Sql/preview/2017-03-01-preview/jobs.json - - ./Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json - - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - - ./Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json - - ./Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - - ./Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json - - ./Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json - - ./Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - - ./Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - - ./Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json - - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json - - ./Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-pure-2015-05-preview - -These settings apply only when `--tag=package-pure-2015-05-preview` is specified on the command line. - -This section contains all input swagger files for version 2015-05-01-preview. All APIs of that version must be added this section when the API is ready for production. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2015-05-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` - -``` yaml $(tag) == 'package-pure-2015-05-preview' -input-file: - - ./Microsoft.Sql/preview/2015-05-01-preview/advisors.json - - ./Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json - - ./Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json - - ./Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json - - ./Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json - - ./Microsoft.Sql/preview/2015-05-01-preview/firewallRules.json - - ./Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json - - ./Microsoft.Sql/preview/2015-05-01-preview/operations.json - - ./Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json - - ./Microsoft.Sql/preview/2015-05-01-preview/servers.json - - ./Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json - - ./Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json - - ./Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json - - ./Microsoft.Sql/preview/2015-05-01-preview/usages.json - - ./Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json - - ./Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -### Tag: package-pure-2014-04 - -These settings apply only when `--tag=package-pure-2014-04` is specified on the command line. - -This section contains all input swagger files for version 2014-04-01-preview. All APIs of that version must be added this section when the API is ready for production. - -APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. - -These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\stable\2014-04-01\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` - -``` yaml $(tag) == 'package-pure-2014-04' -input-file: - - ./Microsoft.Sql/stable/2014-04-01/advisors.json - - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json - - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json - - ./Microsoft.Sql/stable/2014-04-01/backups.json - - ./Microsoft.Sql/stable/2014-04-01/capabilities.json - - ./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json - - ./Microsoft.Sql/stable/2014-04-01/connectionPolicies.json - - ./Microsoft.Sql/stable/2014-04-01/databases.json - - ./Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json - - ./Microsoft.Sql/stable/2014-04-01/dataMasking.json - - ./Microsoft.Sql/stable/2014-04-01/deprecated.json - - ./Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json - - ./Microsoft.Sql/stable/2014-04-01/elasticPools.json - - ./Microsoft.Sql/stable/2014-04-01/firewallRules.json - - ./Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json - - ./Microsoft.Sql/stable/2014-04-01/importExport.json - - ./Microsoft.Sql/stable/2014-04-01/metrics.json - - ./Microsoft.Sql/stable/2014-04-01/operations.json - - ./Microsoft.Sql/stable/2014-04-01/queries.json - - ./Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json - - ./Microsoft.Sql/stable/2014-04-01/replicationLinks.json - - ./Microsoft.Sql/stable/2014-04-01/restorePoints.json - - ./Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json - - ./Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json - - ./Microsoft.Sql/stable/2014-04-01/servers.json - - ./Microsoft.Sql/stable/2014-04-01/serviceObjectives.json - - ./Microsoft.Sql/stable/2014-04-01/sql.core.json - - ./Microsoft.Sql/stable/2014-04-01/tableAuditing.json - - ./Microsoft.Sql/stable/2014-04-01/usages.json - -# Needed when there is more than one input file -override-info: - title: SqlManagementClient -``` - -## Suppression -``` yaml -directive: - - suppress: TrackedResourcePatchOperation - from: restorableDroppedManagedDatabases.json - reason: dropped database shouldn’t support patch -``` - ---- -## Code Generation - -### Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_sql'] -``` - -### C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.Sql - output-folder: $(csharp-sdks-folder)/SqlManagement/Management.Sql/Generated - clear-output-folder: true -``` - -### Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.sql - package-name: azure-mgmt-sql - package-version: 0.9.0 - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-sql/azure/mgmt/sql -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-sql -``` - -### Go - -See configuration in [readme.go.md](./readme.go.md) - -### Java - -See configuration in [readme.java.md](./readme.java.md) - -## Validation - -``` yaml -directive: - - suppress: TrackedResourceListByImmediateParent - reason: This warning gives many false positives for proxy resources. - - suppress: GuidUsage - reason: This warning gives many positives for existing APIs that cannot be changed. - - suppress: EnumInsteadOfBoolean - reason: This warning gives many positives for existing APIs that cannot be changed. -``` +# Sql + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Sql. + +## Getting Started + +To build the SDK for Sql, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +## Configuration + +### Basic Information + +These are the global settings for the Sql API. + +``` yaml +title: SqlManagementClient +description: The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases. +openapi-type: arm +tag: package-composite-v3 +``` + +## Composite packages + +The following packages may be composed from multiple api-versions. + +### Tag: package-composite-v3 + +These settings apply only when `--tag=package-composite-v3` is specified on the command line. + +This section contains the "composite-v3" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v3" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.14.0-preview. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + + +Differences in v3 (compared to v2): + - Decoupled database and recommended elastic pool APIs + - `-2014-04-01/recommendedElasticPools.json` + - `+2014-04-01/recommendedElasticPoolsDecoupled.json` + - Updated to new Sku-based API for databases and elastic pools + - `-2014-04-01/capabilities.json` + - `-2014-04-01/databases.json` + - `-2014-04-01/elasticPools.json` + - `+2017-10-01-preview/capabilities.json` + - `+2017-10-01-preview/databases.json` + - `+2017-10-01-preview/elasticPools.json` + +``` yaml $(tag) == 'package-composite-v3' +input-file: +- Microsoft.Sql/stable/2014-04-01/backups.json +- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json +- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json +- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json +- Microsoft.Sql/stable/2014-04-01/dataMasking.json +- Microsoft.Sql/stable/2014-04-01/firewallRules.json +- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json +- Microsoft.Sql/stable/2014-04-01/importExport.json +- Microsoft.Sql/stable/2014-04-01/metrics.json +- Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json +- Microsoft.Sql/stable/2014-04-01/replicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json +- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json +- Microsoft.Sql/stable/2014-04-01/sql.core.json +- Microsoft.Sql/stable/2014-04-01/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json +- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json +- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +- Microsoft.Sql/preview/2015-05-01-preview/operations.json +- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json +- Microsoft.Sql/preview/2015-05-01-preview/servers.json +- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json +- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json +- Microsoft.Sql/preview/2015-05-01-preview/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json +- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json +- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json +- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json +- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json +- Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/capabilities.json +- Microsoft.Sql/preview/2017-10-01-preview/databases.json +- Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json +- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json +- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json +- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json +- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json + + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-composite-v2 + +These settings apply only when `--tag=package-composite-v2` is specified on the command line. + +This section contains the "composite-v2" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v2" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.13.0-preview. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +Differences in v2 (compared to v1): + +- Updated to LTRv2 + - `-201 4-04-01/backupLongTermRetentionPolicies.json` + - `-2014-04-01/backupLongTermRetentionVaults.json` + - `+2017-03-01-preview/longTermRetention.json` + +``` yaml $(tag) == 'package-composite-v2' +input-file: +- Microsoft.Sql/stable/2014-04-01/backups.json +- Microsoft.Sql/stable/2014-04-01/capabilities.json +- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json +- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json +- Microsoft.Sql/stable/2014-04-01/databases.json +- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json +- Microsoft.Sql/stable/2014-04-01/dataMasking.json +- Microsoft.Sql/stable/2014-04-01/elasticPools.json +- Microsoft.Sql/stable/2014-04-01/firewallRules.json +- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json +- Microsoft.Sql/stable/2014-04-01/importExport.json +- Microsoft.Sql/stable/2014-04-01/metrics.json +- Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json +- Microsoft.Sql/stable/2014-04-01/replicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json +- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json +- Microsoft.Sql/stable/2014-04-01/sql.core.json +- Microsoft.Sql/stable/2014-04-01/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json +- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json +- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +- Microsoft.Sql/preview/2015-05-01-preview/operations.json +- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json +- Microsoft.Sql/preview/2015-05-01-preview/servers.json +- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json +- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json +- Microsoft.Sql/preview/2015-05-01-preview/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json +- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json +- Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json +- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json +- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json +- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json +- Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json +- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json +- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json +- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-composite-v1 + +These settings apply only when `--tag=package-composite-v1` is specified on the command line. + +This section contains the "composite-v1" set of APIs, which is composed from a selection of api-versions that will remain backwards compatible with "v1" clients such as .NET SDK Microsoft.Azure.Management.Sql version 1.12.0-preview and earlier. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +``` yaml $(tag) == 'package-composite-v1' +input-file: +- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json +- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json +- Microsoft.Sql/stable/2014-04-01/backups.json +- Microsoft.Sql/stable/2014-04-01/capabilities.json +- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json +- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json +- Microsoft.Sql/stable/2014-04-01/databases.json +- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json +- Microsoft.Sql/stable/2014-04-01/dataMasking.json +- Microsoft.Sql/stable/2014-04-01/elasticPools.json +- Microsoft.Sql/stable/2014-04-01/firewallRules.json +- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json +- Microsoft.Sql/stable/2014-04-01/importExport.json +- Microsoft.Sql/stable/2014-04-01/metrics.json +- Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json +- Microsoft.Sql/stable/2014-04-01/replicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json +- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json +- Microsoft.Sql/stable/2014-04-01/sql.core.json +- Microsoft.Sql/stable/2014-04-01/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json +- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json +- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +- Microsoft.Sql/preview/2015-05-01-preview/operations.json +- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json +- Microsoft.Sql/preview/2015-05-01-preview/servers.json +- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json +- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json +- Microsoft.Sql/preview/2015-05-01-preview/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json +- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json +- Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json +- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json +- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json +- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json +- Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json +- Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json +- Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json +- Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json +- Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json +- Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json +- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-2017-03-preview + +These settings apply only when `--tag=package-2017-03-preview` is specified on the command line. + +This section contains the input swagger files that are used when generating client SDKs up to and including api-version 2017-03-01-preview, except databases.json which remains at api-version 2014-04-01 in order to maintain compatibility with clients that have been previously released with this package. To prevent similar confusion moving forward, sections named like `package-20xx-xx(-preview)` will not be used after package-2017-03-preview. Instead, sections named like `package-composite-vx` will be used to compose across api-versions and `package-pure-20xx-xx(-preview)` will be used for single api-versions. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +``` yaml $(tag) == 'package-2017-03-preview' +input-file: +- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json +- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json +- Microsoft.Sql/stable/2014-04-01/backups.json +- Microsoft.Sql/stable/2014-04-01/capabilities.json +- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json +- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json +- Microsoft.Sql/stable/2014-04-01/databases.json +- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json +- Microsoft.Sql/stable/2014-04-01/dataMasking.json +- Microsoft.Sql/stable/2014-04-01/elasticPools.json +- Microsoft.Sql/stable/2014-04-01/firewallRules.json +- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json +- Microsoft.Sql/stable/2014-04-01/importExport.json +- Microsoft.Sql/stable/2014-04-01/metrics.json +- Microsoft.Sql/stable/2014-04-01/replicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json +- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json +- Microsoft.Sql/stable/2014-04-01/sql.core.json +- Microsoft.Sql/stable/2014-04-01/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json +- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json +- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +- Microsoft.Sql/preview/2015-05-01-preview/operations.json +- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json +- Microsoft.Sql/preview/2015-05-01-preview/servers.json +- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json +- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json +- Microsoft.Sql/preview/2015-05-01-preview/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json +- Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +- Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json +- Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json +- Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json +- Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json +- Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json +- Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json +- Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json +- Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json +- Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-2015-05-preview + +These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. + +This section contains the input swagger files that are used when generating client SDKs up to and including api-version 2015-05-01-preview. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +``` yaml $(tag) == 'package-2015-05-preview' +input-file: +- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json +- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json +- Microsoft.Sql/stable/2014-04-01/backups.json +- Microsoft.Sql/stable/2014-04-01/restorePoints.json +- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json +- Microsoft.Sql/stable/2014-04-01/connectionPolicies.json +- Microsoft.Sql/stable/2014-04-01/databases.json +- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json +- Microsoft.Sql/stable/2014-04-01/dataMasking.json +- Microsoft.Sql/stable/2014-04-01/elasticPools.json +- Microsoft.Sql/stable/2014-04-01/firewallRules.json +- Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json +- Microsoft.Sql/stable/2014-04-01/importExport.json +- Microsoft.Sql/stable/2014-04-01/metrics.json +- Microsoft.Sql/stable/2014-04-01/replicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json +- Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json +- Microsoft.Sql/stable/2014-04-01/serviceObjectives.json +- Microsoft.Sql/stable/2014-04-01/sql.core.json +- Microsoft.Sql/stable/2014-04-01/usages.json +- Microsoft.Sql/stable/2015-05-01/capabilities.json +- Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json +- Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json +- Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +- Microsoft.Sql/preview/2015-05-01-preview/operations.json +- Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json +- Microsoft.Sql/preview/2015-05-01-preview/servers.json +- Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json +- Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json +- Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json +- Microsoft.Sql/preview/2015-05-01-preview/usages.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json +- Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-2014-04 + +These settings apply only when `--tag=package-2014-04` is specified on the command line. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +``` yaml $(tag) == 'package-2014-04' +input-file: +- Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json +- Microsoft.Sql/stable/2014-04-01/databases.json +- Microsoft.Sql/stable/2014-04-01/elasticPools.json +- Microsoft.Sql/stable/2014-04-01/firewallRules.json +- Microsoft.Sql/stable/2014-04-01/importExport.json +- Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json +- Microsoft.Sql/stable/2014-04-01/replicationLinks.json +- Microsoft.Sql/stable/2014-04-01/sql.core.json +- Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +## Pure package versions + +The following packages are each composed of all apis from only one api-version. + +### Tag: package-pure-2018-06-preview + +These settings apply only when `--tag=package-pure-2018-06-preview` is specified on the command line. + +This section contains all input swagger files for version 2018-06-01-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2018-06-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2018-06-preview' +input-file: + - ./Microsoft.Sql/preview/2018-06-01-preview/DatabaseSecurityAlertPolicies.json + - ./Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json + - ./Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json + - ./Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient + ``` + +### Tag: package-pure-2017-10-preview + +These settings apply only when `--tag=package-pure-2017-10-preview` is specified on the command line. + +This section contains all input swagger files for version 2017-10-01-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-10-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2017-10-preview' +input-file: + - ./Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json + - ./Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json + - ./Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json + - ./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json + - ./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json + - ./Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json + - ./Microsoft.Sql/preview/2017-10-01-preview/capabilities.json + - ./Microsoft.Sql/preview/2017-10-01-preview/databases.json + - ./Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json + - ./Microsoft.Sql/preview/2017-10-01-preview/instanceFailoverGroups.json + - ./Microsoft.Sql/preview/2017-10-01-preview/shortTermRetentionPolicies.json + - ./Microsoft.Sql/preview/2017-10-01-preview/TdeCertificates.json + - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json + - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json + - ./Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json + - ./Microsoft.Sql/preview/2017-10-01-preview/recoverableManagedDatabases.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-pure-2017-03-preview + +These settings apply only when `--tag=package-pure-2017-03-preview` is specified on the command line. + +This section contains all input swagger files for version 2017-03-01-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2017-03-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2017-03-preview' +input-file: + - ./Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json + - ./Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json + - ./Microsoft.Sql/preview/2017-03-01-preview/databases.json + - ./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json + - ./Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json + - ./Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json + - ./Microsoft.Sql/preview/2017-03-01-preview/jobs.json + - ./Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json + - ./Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json + - ./Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json + - ./Microsoft.Sql/preview/2017-03-01-preview/restorableDroppedManagedDatabases.json + - ./Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json + - ./Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json + - ./Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json + - ./Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json + - ./Microsoft.Sql/preview/2017-03-01-preview/SensitivityLabels.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-pure-2015-05-preview + +These settings apply only when `--tag=package-pure-2015-05-preview` is specified on the command line. + +This section contains all input swagger files for version 2015-05-01-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2015-05-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2015-05-preview' +input-file: + - ./Microsoft.Sql/preview/2015-05-01-preview/advisors.json + - ./Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json + - ./Microsoft.Sql/preview/2015-05-01-preview/databaseAutomaticTuning.json + - ./Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json + - ./Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json + - ./Microsoft.Sql/preview/2015-05-01-preview/firewallRules.json + - ./Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json + - ./Microsoft.Sql/preview/2015-05-01-preview/operations.json + - ./Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json + - ./Microsoft.Sql/preview/2015-05-01-preview/servers.json + - ./Microsoft.Sql/preview/2015-05-01-preview/syncAgents.json + - ./Microsoft.Sql/preview/2015-05-01-preview/syncGroups.json + - ./Microsoft.Sql/preview/2015-05-01-preview/syncMembers.json + - ./Microsoft.Sql/preview/2015-05-01-preview/usages.json + - ./Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json + - ./Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +### Tag: package-pure-2014-04 + +These settings apply only when `--tag=package-pure-2014-04` is specified on the command line. + +This section contains all input swagger files for version 2014-04-01-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\stable\2014-04-01\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2014-04' +input-file: + - ./Microsoft.Sql/stable/2014-04-01/advisors.json + - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json + - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json + - ./Microsoft.Sql/stable/2014-04-01/backups.json + - ./Microsoft.Sql/stable/2014-04-01/capabilities.json + - ./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json + - ./Microsoft.Sql/stable/2014-04-01/connectionPolicies.json + - ./Microsoft.Sql/stable/2014-04-01/databases.json + - ./Microsoft.Sql/stable/2014-04-01/databaseSecurityAlertPolicies.json + - ./Microsoft.Sql/stable/2014-04-01/dataMasking.json + - ./Microsoft.Sql/stable/2014-04-01/deprecated.json + - ./Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json + - ./Microsoft.Sql/stable/2014-04-01/elasticPools.json + - ./Microsoft.Sql/stable/2014-04-01/firewallRules.json + - ./Microsoft.Sql/stable/2014-04-01/geoBackupPolicies.json + - ./Microsoft.Sql/stable/2014-04-01/importExport.json + - ./Microsoft.Sql/stable/2014-04-01/metrics.json + - ./Microsoft.Sql/stable/2014-04-01/operations.json + - ./Microsoft.Sql/stable/2014-04-01/queries.json + - ./Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json + - ./Microsoft.Sql/stable/2014-04-01/replicationLinks.json + - ./Microsoft.Sql/stable/2014-04-01/restorePoints.json + - ./Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json + - ./Microsoft.Sql/stable/2014-04-01/serverCommunicationLinks.json + - ./Microsoft.Sql/stable/2014-04-01/servers.json + - ./Microsoft.Sql/stable/2014-04-01/serviceObjectives.json + - ./Microsoft.Sql/stable/2014-04-01/sql.core.json + - ./Microsoft.Sql/stable/2014-04-01/tableAuditing.json + - ./Microsoft.Sql/stable/2014-04-01/usages.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient +``` + +## Suppression +``` yaml +directive: + - suppress: TrackedResourcePatchOperation + from: restorableDroppedManagedDatabases.json + reason: dropped database shouldn’t support patch +``` + +--- +## Code Generation + +### Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_sql'] +``` + +### C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.Sql + output-folder: $(csharp-sdks-folder)/SqlManagement/Management.Sql/Generated + clear-output-folder: true +``` + +### Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.sql + package-name: azure-mgmt-sql + package-version: 0.9.0 + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-sql/azure/mgmt/sql +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-sql +``` + +### Go + +See configuration in [readme.go.md](./readme.go.md) + +### Java + +See configuration in [readme.java.md](./readme.java.md) + +## Validation + +``` yaml +directive: + - suppress: TrackedResourceListByImmediateParent + reason: This warning gives many false positives for proxy resources. + - suppress: GuidUsage + reason: This warning gives many positives for existing APIs that cannot be changed. + - suppress: EnumInsteadOfBoolean + reason: This warning gives many positives for existing APIs that cannot be changed. +``` diff --git a/specification/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md index a4601640154e..02c319e10aac 100644 --- a/specification/storage/resource-manager/readme.md +++ b/specification/storage/resource-manager/readme.md @@ -1,339 +1,339 @@ -# Storage - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Storage. - - - ---- -## Getting Started -To build the SDK for Storage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Storage API. - -``` yaml -openapi-type: arm -tag: package-2019-04 -``` - -### Tag: package-2019-04 - -These settings apply only when `--tag=package-2019-04` is specified on the command line. - -``` yaml $(tag) == 'package-2019-04' -input-file: -- Microsoft.Storage/stable/2019-04-01/storage.json -- Microsoft.Storage/stable/2019-04-01/blob.json - -directive: - - suppress: R3018 - reason: Existing boolean properties - approved-by: "@fearthecowboy" - - - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId - suppress: R1003 - reason: APIs return array of values, is not actually a 'list' operation - approved-by: "@fearthecowboy" - -``` - -### Tag: package-2018-11 - -These settings apply only when `--tag=package-2018-11` is specified on the command line. - -``` yaml $(tag) == 'package-2018-11' -input-file: -- Microsoft.Storage/stable/2018-11-01/storage.json -- Microsoft.Storage/stable/2018-11-01/blob.json - -directive: - - suppress: R3018 - reason: Existing boolean properties - approved-by: "@fearthecowboy" - - - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId - suppress: R1003 - reason: APIs return array of values, is not actually a 'list' operation - approved-by: "@fearthecowboy" - -``` - -### Tag: package-2018-07 - -These settings apply only when `--tag=package-2018-07` is specified on the command line. - -``` yaml $(tag) == 'package-2018-07' -input-file: -- Microsoft.Storage/stable/2018-07-01/storage.json -- Microsoft.Storage/stable/2018-07-01/blob.json -- Microsoft.Storage/preview/2018-03-01-preview/managementpolicy.json - -directive: - - suppress: R3018 - reason: Existing boolean properties - approved-by: "@fearthecowboy" - - - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId - suppress: R1003 - reason: APIs return array of values, is not actually a 'list' operation - approved-by: "@fearthecowboy" - -``` - -### Tag: package-2018-07-only - -These settings apply only when `--tag=package-2018-07-only` is specified on the command line. - -``` yaml $(tag) == 'package-2018-07-only' -input-file: -- Microsoft.Storage/stable/2018-07-01/storage.json -- Microsoft.Storage/stable/2018-07-01/blob.json -``` - -### Tag: package-2018-03 - -These settings apply only when `--tag=package-2018-03` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03' -input-file: -- Microsoft.Storage/preview/2018-03-01-preview/storage.json -- Microsoft.Storage/preview/2018-03-01-preview/blob.json - -directive: - - suppress: R3018 - reason: Existing boolean properties - approved-by: "@fearthecowboy" - - - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId - suppress: R1003 - reason: APIs return array of values, is not actually a 'list' operation - approved-by: "@fearthecowboy" - -``` - -### Tag: package-2018-02 - -These settings apply only when `--tag=package-2018-02` is specified on the command line. - -``` yaml $(tag) == 'package-2018-02' -input-file: -- Microsoft.Storage/stable/2018-02-01/storage.json -- Microsoft.Storage/stable/2018-02-01/blob.json - -directive: - - suppress: R3018 - reason: Existing boolean properties - approved-by: "@fearthecowboy" - - - where: - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId - - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId - suppress: R1003 - reason: APIs return array of values, is not actually a 'list' operation - approved-by: "@fearthecowboy" - -``` - -### Tag: package-2017-10 - -These settings apply only when `--tag=package-2017-10` is specified on the command line. - -``` yaml $(tag) == 'package-2017-10' -input-file: -- Microsoft.Storage/stable/2017-10-01/storage.json -``` - -### Tag: package-2017-06 - -These settings apply only when `--tag=package-2017-06` is specified on the command line. - -``` yaml $(tag) == 'package-2017-06' -input-file: -- Microsoft.Storage/stable/2017-06-01/storage.json -``` - - -### Tag: package-2016-12 - -These settings apply only when `--tag=package-2016-12` is specified on the command line. - -``` yaml $(tag) == 'package-2016-12' -input-file: -- Microsoft.Storage/stable/2016-12-01/storage.json -``` - -### Tag: package-2016-05 - -These settings apply only when `--tag=package-2016-05` is specified on the command line. - -``` yaml $(tag) == 'package-2016-05' -input-file: -- Microsoft.Storage/stable/2016-05-01/storage.json -``` - -### Tag: package-2016-01 - -These settings apply only when `--tag=package-2016-01` is specified on the command line. - -``` yaml $(tag) == 'package-2016-01' -input-file: -- Microsoft.Storage/stable/2016-01-01/storage.json -``` - -### Tag: package-2015-06 - -These settings apply only when `--tag=package-2015-06` is specified on the command line. - -``` yaml $(tag) == 'package-2015-06' -input-file: -- Microsoft.Storage/stable/2015-06-15/storage.json -``` - -### Tag: package-2015-05-preview - -These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-05-preview' -input-file: -- Microsoft.Storage/preview/2015-05-01-preview/storage.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - after_scripts: - - python ./scripts/multiapi_init_gen.py azure-mgmt-storage - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_storage'] -``` - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.storage -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 2 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storage -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-07 - - tag: package-2018-03 - - tag: package-2018-02 - - tag: package-2017-10 - - tag: package-2016-01 -``` - -### Tag: package-2018-07 and java - -These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.storage.v2018_07_01 - output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_07_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-03 and java - -These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.storage.v2018_03_01_preview - output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_03_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-02 and java - -These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.storage.v2018_02_01 - output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_02_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-10 and java - -These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.storage.v2017_10_01 - output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2017_10_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-01 and java - -These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.storage.v2016_01_01 - output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2016_01_01 -regenerate-manager: true -generate-interface: true -``` +# Storage + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Storage. + + + +--- +## Getting Started +To build the SDK for Storage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Storage API. + +``` yaml +openapi-type: arm +tag: package-2019-04 +``` + +### Tag: package-2019-04 + +These settings apply only when `--tag=package-2019-04` is specified on the command line. + +``` yaml $(tag) == 'package-2019-04' +input-file: +- Microsoft.Storage/stable/2019-04-01/storage.json +- Microsoft.Storage/stable/2019-04-01/blob.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` + +### Tag: package-2018-11 + +These settings apply only when `--tag=package-2018-11` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11' +input-file: +- Microsoft.Storage/stable/2018-11-01/storage.json +- Microsoft.Storage/stable/2018-11-01/blob.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` + +### Tag: package-2018-07 + +These settings apply only when `--tag=package-2018-07` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07' +input-file: +- Microsoft.Storage/stable/2018-07-01/storage.json +- Microsoft.Storage/stable/2018-07-01/blob.json +- Microsoft.Storage/preview/2018-03-01-preview/managementpolicy.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` + +### Tag: package-2018-07-only + +These settings apply only when `--tag=package-2018-07-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-only' +input-file: +- Microsoft.Storage/stable/2018-07-01/storage.json +- Microsoft.Storage/stable/2018-07-01/blob.json +``` + +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- Microsoft.Storage/preview/2018-03-01-preview/storage.json +- Microsoft.Storage/preview/2018-03-01-preview/blob.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.Storage/stable/2018-02-01/storage.json +- Microsoft.Storage/stable/2018-02-01/blob.json + +directive: + - suppress: R3018 + reason: Existing boolean properties + approved-by: "@fearthecowboy" + + - where: + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/setLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}/clearLegalHold"].post.operationId + - $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/regenerateKey"].post.operationId + suppress: R1003 + reason: APIs return array of values, is not actually a 'list' operation + approved-by: "@fearthecowboy" + +``` + +### Tag: package-2017-10 + +These settings apply only when `--tag=package-2017-10` is specified on the command line. + +``` yaml $(tag) == 'package-2017-10' +input-file: +- Microsoft.Storage/stable/2017-10-01/storage.json +``` + +### Tag: package-2017-06 + +These settings apply only when `--tag=package-2017-06` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06' +input-file: +- Microsoft.Storage/stable/2017-06-01/storage.json +``` + + +### Tag: package-2016-12 + +These settings apply only when `--tag=package-2016-12` is specified on the command line. + +``` yaml $(tag) == 'package-2016-12' +input-file: +- Microsoft.Storage/stable/2016-12-01/storage.json +``` + +### Tag: package-2016-05 + +These settings apply only when `--tag=package-2016-05` is specified on the command line. + +``` yaml $(tag) == 'package-2016-05' +input-file: +- Microsoft.Storage/stable/2016-05-01/storage.json +``` + +### Tag: package-2016-01 + +These settings apply only when `--tag=package-2016-01` is specified on the command line. + +``` yaml $(tag) == 'package-2016-01' +input-file: +- Microsoft.Storage/stable/2016-01-01/storage.json +``` + +### Tag: package-2015-06 + +These settings apply only when `--tag=package-2015-06` is specified on the command line. + +``` yaml $(tag) == 'package-2015-06' +input-file: +- Microsoft.Storage/stable/2015-06-15/storage.json +``` + +### Tag: package-2015-05-preview + +These settings apply only when `--tag=package-2015-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-05-preview' +input-file: +- Microsoft.Storage/preview/2015-05-01-preview/storage.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-storage + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_storage'] +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.storage +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 2 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storage +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-07 + - tag: package-2018-03 + - tag: package-2018-02 + - tag: package-2017-10 + - tag: package-2016-01 +``` + +### Tag: package-2018-07 and java + +These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2018_07_01 + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_07_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03 and java + +These settings apply only when `--tag=package-2018-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2018_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_03_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-02 and java + +These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2018_02_01 + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_02_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-10 and java + +These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2017-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2017_10_01 + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2017_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-01 and java + +These settings apply only when `--tag=package-2016-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storage.v2016_01_01 + output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2016_01_01 +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/storageimportexport/resource-manager/readme.md b/specification/storageimportexport/resource-manager/readme.md index 883caf01953a..acad936ff069 100644 --- a/specification/storageimportexport/resource-manager/readme.md +++ b/specification/storageimportexport/resource-manager/readme.md @@ -1,96 +1,96 @@ -# StorageImportExport - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for StorageImportExport. - - - ---- -## Getting Started -To build the SDK for StorageImportExport, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the StorageImportExport API. - -``` yaml -openapi-type: arm -tag: package-2016-11 -``` - - -### Tag: package-2016-11 - -These settings apply only when `--tag=package-2016-11` is specified on the command line. - -``` yaml $(tag) == 'package-2016-11' -input-file: -- Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json -``` - - ---- -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.storageimportexport -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storageimportexport -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-11 -``` - -### Tag: package-2016-11 and java - -These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.storageimportexport.v2016_11_01 - output-folder: $(azure-libraries-for-java-folder)/storageimportexport/resource-manager/v2016_11_01 -regenerate-manager: true -generate-interface: true -``` - - +# StorageImportExport + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for StorageImportExport. + + + +--- +## Getting Started +To build the SDK for StorageImportExport, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the StorageImportExport API. + +``` yaml +openapi-type: arm +tag: package-2016-11 +``` + + +### Tag: package-2016-11 + +These settings apply only when `--tag=package-2016-11` is specified on the command line. + +``` yaml $(tag) == 'package-2016-11' +input-file: +- Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json +``` + + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.storageimportexport +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storageimportexport +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-11 +``` + +### Tag: package-2016-11 and java + +These settings apply only when `--tag=package-2016-11 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2016-11' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storageimportexport.v2016_11_01 + output-folder: $(azure-libraries-for-java-folder)/storageimportexport/resource-manager/v2016_11_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md index 2cf86e9675be..9ba9282a6ebe 100644 --- a/specification/storagesync/resource-manager/readme.md +++ b/specification/storagesync/resource-manager/readme.md @@ -1,146 +1,146 @@ -# StorageSync - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for StorageSync. - ---- - -## Getting Started - -To build the SDK for Storage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` - ---- - -## Configuration - -### Basic Information - -These are the global settings for the Storage Sync API. - -``` yaml -openapi-type: arm -tag: package-2019-02-01 -``` - -### Tag: package-2019-02-01 - -These settings apply only when `--tag=package-2019-02-01` is specified on the command line. - -```yaml $(tag) == 'package-2019-02-01' -input-file: - - Microsoft.StorageSync/stable/2019-02-01/storagesync.json -``` - -### Tag: package-2018-10-01 - -These settings apply only when `--tag=package-2018-07-01` is specified on the command line. - -``` yaml $(tag) == 'package-2018-10-01' -input-file: -- Microsoft.StorageSync/stable/2018-10-01/storagesync.json -``` - -### Tag: package-2018-07-01 - -These settings apply only when `--tag=package-2018-07-01` is specified on the command line. - -``` yaml $(tag) == 'package-2018-07-01' -input-file: -- Microsoft.StorageSync/stable/2018-07-01/storagesync.json -``` - -### Tag: package-2018-04-02 - -These settings apply only when `--tag=package-2018-04-02` is specified on the command line. - -``` yaml $(tag) == 'package-2018-04-02' -input-file: -- Microsoft.StorageSync/stable/2018-04-02/storagesync.json -``` - -### Tag: package-2017-06-05-preview - -These settings apply only when `--tag=package-2017-06-05-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-06-05-preview' -input-file: -- Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node -``` - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.StorageSync - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/StorageSync/Management.StorageSync/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.storagesync - package-name: azure-mgmt-storagesync - package-version: 1.0.0 - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-storagesync/azure/mgmt/storagesync -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-storagesync -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -See configuration in [readme.java.md](./readme.java.md) +# StorageSync + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for StorageSync. + +--- + +## Getting Started + +To build the SDK for Storage, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Storage Sync API. + +``` yaml +openapi-type: arm +tag: package-2019-02-01 +``` + +### Tag: package-2019-02-01 + +These settings apply only when `--tag=package-2019-02-01` is specified on the command line. + +```yaml $(tag) == 'package-2019-02-01' +input-file: + - Microsoft.StorageSync/stable/2019-02-01/storagesync.json +``` + +### Tag: package-2018-10-01 + +These settings apply only when `--tag=package-2018-07-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-10-01' +input-file: +- Microsoft.StorageSync/stable/2018-10-01/storagesync.json +``` + +### Tag: package-2018-07-01 + +These settings apply only when `--tag=package-2018-07-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-01' +input-file: +- Microsoft.StorageSync/stable/2018-07-01/storagesync.json +``` + +### Tag: package-2018-04-02 + +These settings apply only when `--tag=package-2018-04-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04-02' +input-file: +- Microsoft.StorageSync/stable/2018-04-02/storagesync.json +``` + +### Tag: package-2017-06-05-preview + +These settings apply only when `--tag=package-2017-06-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06-05-preview' +input-file: +- Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.StorageSync + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/StorageSync/Management.StorageSync/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.storagesync + package-name: azure-mgmt-storagesync + package-version: 1.0.0 + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-storagesync/azure/mgmt/storagesync +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-storagesync +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/storsimple8000series/resource-manager/readme.md b/specification/storsimple8000series/resource-manager/readme.md index 8825c9c52582..840a3bb02f34 100644 --- a/specification/storsimple8000series/resource-manager/readme.md +++ b/specification/storsimple8000series/resource-manager/readme.md @@ -1,118 +1,118 @@ -# StorSimple - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for StorSimple. - - - ---- -## Getting Started -To build the SDK for StorSimple, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the StorSimple API. - -``` yaml -openapi-type: arm -tag: package-2017-06 -``` - - -### Tag: package-2017-06 - -These settings apply only when `--tag=package-2017-06` is specified on the command line. - -``` yaml $(tag) == 'package-2017-06' -input-file: -- Microsoft.StorSimple/stable/2017-06-01/storsimple.json -directive: - - suppress: - - R2016 #to suppress (PatchBodyParametersSchema/R2016/RPCViolation) - - R2062 #to suppress (XmsResourceInPutResponse/R2062/RPCViolation) -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_stor_simple8000_series'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.StorSimple8000Series - output-folder: $(csharp-sdks-folder)/StorSimple8000Series/Management.StorSimple8000Series/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.storsimple8000series -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storsimple8000series -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-06 -``` - -### Tag: package-2017-06 and java - -These settings apply only when `--tag=package-2017-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.storsimple.v2017_06_01 - output-folder: $(azure-libraries-for-java-folder)/storsimple/resource-manager/v2017_06_01 -regenerate-manager: true -generate-interface: true -``` - - +# StorSimple + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for StorSimple. + + + +--- +## Getting Started +To build the SDK for StorSimple, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the StorSimple API. + +``` yaml +openapi-type: arm +tag: package-2017-06 +``` + + +### Tag: package-2017-06 + +These settings apply only when `--tag=package-2017-06` is specified on the command line. + +``` yaml $(tag) == 'package-2017-06' +input-file: +- Microsoft.StorSimple/stable/2017-06-01/storsimple.json +directive: + - suppress: + - R2016 #to suppress (PatchBodyParametersSchema/R2016/RPCViolation) + - R2062 #to suppress (XmsResourceInPutResponse/R2062/RPCViolation) +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_stor_simple8000_series'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.StorSimple8000Series + output-folder: $(csharp-sdks-folder)/StorSimple8000Series/Management.StorSimple8000Series/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.storsimple8000series +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storsimple8000series +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-06 +``` + +### Tag: package-2017-06 and java + +These settings apply only when `--tag=package-2017-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storsimple.v2017_06_01 + output-folder: $(azure-libraries-for-java-folder)/storsimple/resource-manager/v2017_06_01 +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/streamanalytics/resource-manager/readme.md b/specification/streamanalytics/resource-manager/readme.md index f91a1fb2788d..50ee44af1ac6 100644 --- a/specification/streamanalytics/resource-manager/readme.md +++ b/specification/streamanalytics/resource-manager/readme.md @@ -1,151 +1,151 @@ -# StreamAnalytics - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for StreamAnalytics. - - - ---- -## Getting Started -To build the SDK for StreamAnalytics, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the StreamAnalytics API. - -``` yaml -title: Stream Analytics Management Client -description: Stream Analytics Client -openapi-type: arm -tag: package-2016-03 -``` - - -### Tag: package-2016-03 - -These settings apply only when `--tag=package-2016-03` is specified on the command line. - -``` yaml $(tag) == 'package-2016-03' -input-file: -- Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json -- Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json -- Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json -- Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json -- Microsoft.StreamAnalytics/stable/2016-03-01/functions.json -- Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_stream_analytics'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.StreamAnalytics - output-folder: $(csharp-sdks-folder)/StreamAnalytics/Management.StreamAnalytics/Generated - clear-output-folder: true -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.streamanalytics -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-streamanalytics -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2016-03 -``` - -### Tag: package-2016-03 and java - -These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.streamanalytics.v2016_03_01 - output-folder: $(azure-libraries-for-java-folder)/streamanalytics/resource-manager/v2016_03_01 -regenerate-manager: true -generate-interface: true -``` - - -# Suppression - -``` yaml -directive: - - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. - where: $.definitions.Input - from: inputs.json - reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. - - - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. - where: $.definitions.Output - from: outputs.json - reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. - - - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. - where: $.definitions.Transformation - from: transformations.json - reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. - - - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. - where: $.definitions.Function - from: functions.json - reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. - - - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. - where: $.definitions.SubscriptionQuota - from: subscriptions.json - reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. -``` +# StreamAnalytics + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for StreamAnalytics. + + + +--- +## Getting Started +To build the SDK for StreamAnalytics, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the StreamAnalytics API. + +``` yaml +title: Stream Analytics Management Client +description: Stream Analytics Client +openapi-type: arm +tag: package-2016-03 +``` + + +### Tag: package-2016-03 + +These settings apply only when `--tag=package-2016-03` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03' +input-file: +- Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json +- Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json +- Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json +- Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json +- Microsoft.StreamAnalytics/stable/2016-03-01/functions.json +- Microsoft.StreamAnalytics/stable/2016-03-01/subscriptions.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_stream_analytics'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.StreamAnalytics + output-folder: $(csharp-sdks-folder)/StreamAnalytics/Management.StreamAnalytics/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.streamanalytics +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-streamanalytics +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2016-03 +``` + +### Tag: package-2016-03 and java + +These settings apply only when `--tag=package-2016-03 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-03' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.streamanalytics.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/streamanalytics/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true +``` + + +# Suppression + +``` yaml +directive: + - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. + where: $.definitions.Input + from: inputs.json + reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. + + - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. + where: $.definitions.Output + from: outputs.json + reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. + + - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. + where: $.definitions.Transformation + from: transformations.json + reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. + + - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. + where: $.definitions.Function + from: functions.json + reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. + + - suppress: R2020 # Model definition 'XXX' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. + where: $.definitions.SubscriptionQuota + from: subscriptions.json + reason: Need the “name” property to be writable on nested resources so that our RP can support a DEEP PUT scenario which at the time, ARM did not have a native way to support. +``` diff --git a/specification/timeseriesinsights/resource-manager/readme.md b/specification/timeseriesinsights/resource-manager/readme.md index 15fc58484ddf..66d8c7ea2f7a 100644 --- a/specification/timeseriesinsights/resource-manager/readme.md +++ b/specification/timeseriesinsights/resource-manager/readme.md @@ -1,161 +1,161 @@ -# TimeSeriesInsights - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for TimeSeriesInsights. - ---- - -## Getting Started - -To build the SDK for TimeSeriesInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - -### Basic Information - -These are the global settings for the TimeSeriesInsights API. - -``` yaml -openapi-type: arm -tag: package-2017-11-15 -``` - -### Tag: package-2017-02-preview - -These settings apply only when `--tag=package-2017-02-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-02-preview' -input-file: -- Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json -``` - -### Tag: package-2017-11-15 - -These settings apply only when `--tag=package-2017-11-15` is specified on the command line. - -``` yaml $(tag) == 'package-2017-11-15' -input-file: -- Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json -``` - -### Tag: package-2018-08-preview - -These settings apply only when `--tag=package-2018-08-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2018-08-preview' -input-file: -- Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json -``` - -## Suppression - -``` yaml -directive: - - suppress: R3025 # Tracked resource 'XXX' must have a get operation - where: - - $.definitions.StandardEnvironmentResource - - $.definitions.LongTermEnvironmentResource - - $.definitions.EventHubEventSourceResource - - $.definitions.IoTHubEventSourceResource - from: timeseriesinsights.json - reason: These violations are false positives. The EventSources_Get operation returns an EventSourceResource, and both EventHubEventSourceResource and IoTHubEventSourceResource inherit from EventSourceResource. Similarly, the Environments_Get operation returns an EnvironmentResource, from which both StandardEnvironmentResource and LongTermEnvironmentResource inherit. - - - suppress: R3026 # Tracked resource 'XXX' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well. - where: - - $.definitions.StandardEnvironmentResource - - $.definitions.LongTermEnvironmentResource - - $.definitions.EventHubEventSourceResource - - $.definitions.IoTHubEventSourceResource - from: timeseriesinsights.json - reason: These violations are false positives. The EventSources_Update operation takes an EventSourceUpdateParameters as the body, and EventHubEventSourceUpdateParameters and IoTHubEventSourceUpdateParameters both inherit from EventSourceUpdateParameters. Similarly, the Environments_Update operation takes an EnvironmentUpdateParameters as the body, and both StandardEnvironmentUpdateParameters and LongTermEnvironmentUpdateParameters inherit from EnvironmentUpdateParameters. These definitions can be used to update mutable properties of the event source, including the Tags collection. -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.timeseriesinsights -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-timeseriesinsights -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2017-11-15 - - tag: package-2017-02-preview - - tag: package-2018-08-preview -``` - -### Tag: package-2017-11-15 and java - -These settings apply only when `--tag=package-2017-11-15 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-11-15' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.timeseriesinsights.v2017_11_15 - output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2017_11_15 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-02-preview and java - -These settings apply only when `--tag=package-2017-02-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.timeseriesinsights.v2017_02_28_preview - output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2017_02_28_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-08-preview and java - -These settings apply only when `--tag=package-2018-08-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-08-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.timeseriesinsights.v2018_08_15_preview - output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2018_08_15_preview -regenerate-manager: true -generate-interface: true -``` +# TimeSeriesInsights + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for TimeSeriesInsights. + +--- + +## Getting Started + +To build the SDK for TimeSeriesInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information + +These are the global settings for the TimeSeriesInsights API. + +``` yaml +openapi-type: arm +tag: package-2017-11-15 +``` + +### Tag: package-2017-02-preview + +These settings apply only when `--tag=package-2017-02-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-02-preview' +input-file: +- Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json +``` + +### Tag: package-2017-11-15 + +These settings apply only when `--tag=package-2017-11-15` is specified on the command line. + +``` yaml $(tag) == 'package-2017-11-15' +input-file: +- Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json +``` + +### Tag: package-2018-08-preview + +These settings apply only when `--tag=package-2018-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-08-preview' +input-file: +- Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json +``` + +## Suppression + +``` yaml +directive: + - suppress: R3025 # Tracked resource 'XXX' must have a get operation + where: + - $.definitions.StandardEnvironmentResource + - $.definitions.LongTermEnvironmentResource + - $.definitions.EventHubEventSourceResource + - $.definitions.IoTHubEventSourceResource + from: timeseriesinsights.json + reason: These violations are false positives. The EventSources_Get operation returns an EventSourceResource, and both EventHubEventSourceResource and IoTHubEventSourceResource inherit from EventSourceResource. Similarly, the Environments_Get operation returns an EnvironmentResource, from which both StandardEnvironmentResource and LongTermEnvironmentResource inherit. + + - suppress: R3026 # Tracked resource 'XXX' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well. + where: + - $.definitions.StandardEnvironmentResource + - $.definitions.LongTermEnvironmentResource + - $.definitions.EventHubEventSourceResource + - $.definitions.IoTHubEventSourceResource + from: timeseriesinsights.json + reason: These violations are false positives. The EventSources_Update operation takes an EventSourceUpdateParameters as the body, and EventHubEventSourceUpdateParameters and IoTHubEventSourceUpdateParameters both inherit from EventSourceUpdateParameters. Similarly, the Environments_Update operation takes an EnvironmentUpdateParameters as the body, and both StandardEnvironmentUpdateParameters and LongTermEnvironmentUpdateParameters inherit from EnvironmentUpdateParameters. These definitions can be used to update mutable properties of the event source, including the Tags collection. +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.timeseriesinsights +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-timeseriesinsights +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2017-11-15 + - tag: package-2017-02-preview + - tag: package-2018-08-preview +``` + +### Tag: package-2017-11-15 and java + +These settings apply only when `--tag=package-2017-11-15 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-11-15' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.timeseriesinsights.v2017_11_15 + output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2017_11_15 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-02-preview and java + +These settings apply only when `--tag=package-2017-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.timeseriesinsights.v2017_02_28_preview + output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2017_02_28_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-08-preview and java + +These settings apply only when `--tag=package-2018-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-08-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.timeseriesinsights.v2018_08_15_preview + output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2018_08_15_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/trafficmanager/resource-manager/readme.md b/specification/trafficmanager/resource-manager/readme.md index 82e4c3822794..c42f6729cbeb 100644 --- a/specification/trafficmanager/resource-manager/readme.md +++ b/specification/trafficmanager/resource-manager/readme.md @@ -1,246 +1,246 @@ -# TrafficManager - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for TrafficManager. - - - ---- -## Getting Started -To build the SDK for TrafficManager, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - -### Basic Information -These are the global settings for the TrafficManager API. - -``` yaml -openapi-type: arm -tag: package-2018-04 -``` - -## Suppression -``` yaml -directive: - - suppress: OperationsAPIImplementation - reason: We do have a operations api as "/providers/Microsoft.Network/operations" - from: trafficmanager.json - where: $.paths - - suppress: RequiredPropertiesMissingInResourceModel - reason: This will cause breaking changes in .NET SDK - from: trafficmanager.json - where: $.definitions.HeatMapModel - - suppress: RequiredPropertiesMissingInResourceModel - reason: This will cause breaking changes in .NET SDK - from: trafficmanager.json - where: $.definitions.TrafficManagerGeographicHierarchy - - suppress: RequiredPropertiesMissingInResourceModel - reason: This will cause breaking changes in .NET SDK - from: trafficmanager.json - where: $.definitions.Profile - - suppress: RequiredPropertiesMissingInResourceModel - reason: This will cause breaking changes in .NET SDK - from: trafficmanager.json - where: $.definitions.Endpoint - - suppress: RequiredPropertiesMissingInResourceModel - reason: This will cause breaking changes in .NET SDK - from: trafficmanager.json - where: $.definitions.UserMetricsModel -``` - -### Tag: package-2018-04 - -These settings apply only when `--tag=package-2018-04` is specified on the command line. - -``` yaml $(tag) == 'package-2018-04' -input-file: -- Microsoft.Network/stable/2018-04-01/trafficmanager.json -``` - -### Tag: package-2018-03 - -These settings apply only when `--tag=package-2018-03` is specified on the command line. - -``` yaml $(tag) == 'package-2018-03' -input-file: -- Microsoft.Network/stable/2018-03-01/trafficmanager.json -``` - -### Tag: package-2018-02 - -These settings apply only when `--tag=package-2018-02` is specified on the command line. - -``` yaml $(tag) == 'package-2018-02' -input-file: -- Microsoft.Network/stable/2018-02-01/trafficmanager.json -- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json - -# Needed when there is more than one input file -override-info: - title: TrafficManagerManagementClient - -directive: - - suppress: R3023 - reason: it's implemented in the main network spec - approved-by: "@fearthecowboy" - - - where: $.paths["/providers/Microsoft.Network/checkTrafficManagerNameAvailability"].post.operationId - suppress: R2066 - reason: the name does include it. - approved-by: "@fearthecowboy" - - - suppress: R3018 - reason: Existing API; can't change. - approved-by: "@fearthecowboy" - - - where: $.definitions.TrafficManagerUserMetricsKeyModel.properties - suppress: R3006 - reason: Existing API; can't change without breaking API. Will consider in future API version - approved-by: "@fearthecowboy" - -``` -### Tag: package-2017-09-preview - -These settings apply only when `--tag=package-2017-09-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09-preview' -input-file: -- Microsoft.Network/stable/2017-05-01/trafficmanager.json -- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json - -# Needed when there is more than one input file -override-info: - title: TrafficManagerManagementClient -``` - -### Tag: package-2017-09-preview-only - -These settings apply only when `--tag=package-2017-09-preview-only` is specified on the command line. - -``` yaml $(tag) == 'package-2017-09-preview-only' -input-file: -- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json -``` - - -### Tag: package-2017-05 - -These settings apply only when `--tag=package-2017-05` is specified on the command line. - -``` yaml $(tag) == 'package-2017-05' -input-file: -- Microsoft.Network/stable/2017-05-01/trafficmanager.json -``` - - -### Tag: package-2017-03 - -These settings apply only when `--tag=package-2017-03` is specified on the command line. - -``` yaml $(tag) == 'package-2017-03' -input-file: -- Microsoft.Network/stable/2017-03-01/trafficmanager.json -``` - -### Tag: package-2015-11 - -These settings apply only when `--tag=package-2015-11` is specified on the command line. - -``` yaml $(tag) == 'package-2015-11' -input-file: -- Microsoft.Network/stable/2015-11-01/trafficmanager.json -``` - - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-libraries-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_traffic_manager'] -``` - - -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -``` yaml $(csharp) -csharp: - # last generated with commit 9e35e9c1e14dc46fcb1837ad108bba185ccaf9a9 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - namespace: Microsoft.Azure.Management.TrafficManager - payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/TrafficManager/Management.TrafficManager/Generated - clear-output-folder: true -``` - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.trafficmanager - package-name: azure-mgmt-trafficmanager - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-trafficmanager/azure/mgmt/trafficmanager -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-trafficmanager -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.trafficmanager - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-trafficmanager -``` +# TrafficManager + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for TrafficManager. + + + +--- +## Getting Started +To build the SDK for TrafficManager, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + +### Basic Information +These are the global settings for the TrafficManager API. + +``` yaml +openapi-type: arm +tag: package-2018-04 +``` + +## Suppression +``` yaml +directive: + - suppress: OperationsAPIImplementation + reason: We do have a operations api as "/providers/Microsoft.Network/operations" + from: trafficmanager.json + where: $.paths + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.HeatMapModel + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.TrafficManagerGeographicHierarchy + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.Profile + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.Endpoint + - suppress: RequiredPropertiesMissingInResourceModel + reason: This will cause breaking changes in .NET SDK + from: trafficmanager.json + where: $.definitions.UserMetricsModel +``` + +### Tag: package-2018-04 + +These settings apply only when `--tag=package-2018-04` is specified on the command line. + +``` yaml $(tag) == 'package-2018-04' +input-file: +- Microsoft.Network/stable/2018-04-01/trafficmanager.json +``` + +### Tag: package-2018-03 + +These settings apply only when `--tag=package-2018-03` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03' +input-file: +- Microsoft.Network/stable/2018-03-01/trafficmanager.json +``` + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.Network/stable/2018-02-01/trafficmanager.json +- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json + +# Needed when there is more than one input file +override-info: + title: TrafficManagerManagementClient + +directive: + - suppress: R3023 + reason: it's implemented in the main network spec + approved-by: "@fearthecowboy" + + - where: $.paths["/providers/Microsoft.Network/checkTrafficManagerNameAvailability"].post.operationId + suppress: R2066 + reason: the name does include it. + approved-by: "@fearthecowboy" + + - suppress: R3018 + reason: Existing API; can't change. + approved-by: "@fearthecowboy" + + - where: $.definitions.TrafficManagerUserMetricsKeyModel.properties + suppress: R3006 + reason: Existing API; can't change without breaking API. Will consider in future API version + approved-by: "@fearthecowboy" + +``` +### Tag: package-2017-09-preview + +These settings apply only when `--tag=package-2017-09-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09-preview' +input-file: +- Microsoft.Network/stable/2017-05-01/trafficmanager.json +- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json + +# Needed when there is more than one input file +override-info: + title: TrafficManagerManagementClient +``` + +### Tag: package-2017-09-preview-only + +These settings apply only when `--tag=package-2017-09-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2017-09-preview-only' +input-file: +- Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json +``` + + +### Tag: package-2017-05 + +These settings apply only when `--tag=package-2017-05` is specified on the command line. + +``` yaml $(tag) == 'package-2017-05' +input-file: +- Microsoft.Network/stable/2017-05-01/trafficmanager.json +``` + + +### Tag: package-2017-03 + +These settings apply only when `--tag=package-2017-03` is specified on the command line. + +``` yaml $(tag) == 'package-2017-03' +input-file: +- Microsoft.Network/stable/2017-03-01/trafficmanager.json +``` + +### Tag: package-2015-11 + +These settings apply only when `--tag=package-2015-11` is specified on the command line. + +``` yaml $(tag) == 'package-2015-11' +input-file: +- Microsoft.Network/stable/2015-11-01/trafficmanager.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-libraries-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_traffic_manager'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + # last generated with commit 9e35e9c1e14dc46fcb1837ad108bba185ccaf9a9 + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.TrafficManager + payload-flattening-threshold: 2 + output-folder: $(csharp-sdks-folder)/TrafficManager/Management.TrafficManager/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.trafficmanager + package-name: azure-mgmt-trafficmanager + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-trafficmanager/azure/mgmt/trafficmanager +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-trafficmanager +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + fluent: true + namespace: com.microsoft.azure.management.trafficmanager + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-trafficmanager +``` diff --git a/specification/visualstudio/resource-manager/readme.md b/specification/visualstudio/resource-manager/readme.md index 7024b0319542..94a59b5a4484 100644 --- a/specification/visualstudio/resource-manager/readme.md +++ b/specification/visualstudio/resource-manager/readme.md @@ -1,103 +1,103 @@ -# VisualStudio - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for VisualStudio. - - -The App service RP comprises of services where each service has its own tag. -Hence, each sub-service has its own swagger spec. - -All of them are tied together using this configuration and are packaged together into one compute client library. -This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. - - ---- -## Getting Started -To build the SDK for VisualStudio, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the VisualStudio API. - -``` yaml -openapi-type: arm -tag: package-2014-04-preview -``` - - -### Tag: package-2014-04-preview - -These settings apply only when `--tag=package-2014-04-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2014-04-preview' -input-file: -- Microsoft.VisualStudio/preview/2014-04-01-preview/Csm.json -``` - - ---- -## Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.visualstudio -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-visualstudio -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2014-04-preview -``` - -### Tag: package-2014-04-preview and java - -These settings apply only when `--tag=package-2014-04-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2014-04-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.visualstudio.v2014_04_01_preview - output-folder: $(azure-libraries-for-java-folder)/visualstudio/resource-manager/v2014_04_01_preview -regenerate-manager: true -generate-interface: true -``` - - +# VisualStudio + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for VisualStudio. + + +The App service RP comprises of services where each service has its own tag. +Hence, each sub-service has its own swagger spec. + +All of them are tied together using this configuration and are packaged together into one compute client library. +This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. + + +--- +## Getting Started +To build the SDK for VisualStudio, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the VisualStudio API. + +``` yaml +openapi-type: arm +tag: package-2014-04-preview +``` + + +### Tag: package-2014-04-preview + +These settings apply only when `--tag=package-2014-04-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2014-04-preview' +input-file: +- Microsoft.VisualStudio/preview/2014-04-01-preview/Csm.json +``` + + +--- +## Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.visualstudio +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-visualstudio +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2014-04-preview +``` + +### Tag: package-2014-04-preview and java + +These settings apply only when `--tag=package-2014-04-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2014-04-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.visualstudio.v2014_04_01_preview + output-folder: $(azure-libraries-for-java-folder)/visualstudio/resource-manager/v2014_04_01_preview +regenerate-manager: true +generate-interface: true +``` + + diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 5e5c9e787795..3e8a7a46b78d 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -1,468 +1,468 @@ -# Web - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Web. - - -The App service RP comprises of services where each service has its own tag. -Hence, each sub-service has its own swagger spec. - -All of them are tied together using this configuration and are packaged together into one compute client library. -This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. - - ---- -## Getting Started -To build the SDK for Web, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Web API. - -``` yaml -title: WebSiteManagementClient -description: WebSite Management Client -openapi-type: arm -tag: package-2018-11 -``` - -### Tag: package-2018-11 - -These settings apply only when `--tag=package-2018-11` is specified on the command line. - -``` yaml $(tag) == 'package-2018-11' -input-file: -- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json -- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2018-11-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json -- Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json -directive: - # suppress each RPC 3019 error -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -``` - - -### Tag: package-2018-02 - -These settings apply only when `--tag=package-2018-02` is specified on the command line. - -``` yaml $(tag) == 'package-2018-02' -input-file: -- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json -- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2018-02-01/Certificates.json -- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json -- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json -- Microsoft.Web/stable/2018-02-01/Diagnostics.json -- Microsoft.Web/stable/2018-02-01/Provider.json -- Microsoft.Web/stable/2018-02-01/Recommendations.json -- Microsoft.Web/stable/2018-02-01/ResourceProvider.json -- Microsoft.Web/stable/2018-02-01/WebApps.json -- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2018-02-01/AppServicePlans.json -- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json -directive: - # suppress each RPC 3019 error -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -``` - -### Tag: package-2016-09 - -These settings apply only when `--tag=package-2016-09` is specified on the command line. - -``` yaml $(tag) == 'package-2016-09' -input-file: -- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json -- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json -- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json -- Microsoft.Web/stable/2016-03-01/Certificates.json -- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json -- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json -- Microsoft.Web/stable/2016-03-01/Diagnostics.json -- Microsoft.Web/stable/2016-03-01/Provider.json -- Microsoft.Web/stable/2016-03-01/Recommendations.json -- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json -- Microsoft.Web/stable/2016-03-01/ResourceProvider.json -- Microsoft.Web/stable/2016-08-01/WebApps.json -- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2016-09-01/AppServicePlans.json -directive: - # suppress each RPC 3019 error -- where: $.definitions.User.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SourceControl.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.BackupRequest.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Deployment.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Identifier.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOn.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteExtensionInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlan.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.VnetRoute.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.FunctionEnvelope.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.CertificateOrderAction.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ResourceMetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TopLevelDomain.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.GeoRegion.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.PremierAddOnOffer.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ContinuousWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.ProcessThreadInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteConfigurationSnapshotInfo.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SiteInstance.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.SlotDifference.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredJobRun.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.TriggeredWebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.WebJob.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.MetricDefinition.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.Usage.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -- where: $.definitions.AppServicePlanPatchResource.properties - suppress: R3019 - reason: It's an old API, will resolve in next API version - approved-by: "@ravbhatnagar" -``` - -### Tag: package-2015-08-preview - -These settings apply only when `--tag=package-2015-08-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2015-08-preview' -input-file: -- Microsoft.Web/stable/2015-08-01/service.json -- Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json -``` - -### Tag: package-2015-08-certificate-registration - -These settings apply only when `--tag=package-2015-08-certificate-registration` is specified on the command line. - -``` yaml $(tag) == 'package-2015-08-certificate-registration' -input-file: -- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json -- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json -``` - -### Tag: package-2015-04-domain-registration - -These settings apply only when `--tag=package-2015-04-domain-registration` is specified on the command line. - -``` yaml $(tag) == 'package-2015-04-domain-registration' -input-file: -- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json -- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json -- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json -``` - -### Tag: package-2016-09-01-web - -These settings apply only when `--tag=package-2016-09-01-web` is specified on the command line. - -``` yaml $(tag) == 'package-2016-09-01-web' -input-file: -- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2016-09-01/AppServicePlans.json -``` - -### Tag: package-2016-08-01-web - -These settings apply only when `--tag=package-2016-08-01-web` is specified on the command line. - -``` yaml $(tag) == 'package-2016-08-01-web' -input-file: -- Microsoft.Web/stable/2016-08-01/WebApps.json -``` - -### Tag: package-2016-03-01-web - -These settings apply only when `--tag=package-2016-03-01-web` is specified on the command line. - -``` yaml $(tag) == 'package-2016-03-01-web' -input-file: -- Microsoft.Web/stable/2016-03-01/Certificates.json -- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json -- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json -- Microsoft.Web/stable/2016-03-01/Diagnostics.json -- Microsoft.Web/stable/2016-03-01/Provider.json -- Microsoft.Web/stable/2016-03-01/Recommendations.json -- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json -- Microsoft.Web/stable/2016-03-01/ResourceProvider.json -``` - ---- -# Code Generation - - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-node - - repo: azure-sdk-for-js - - repo: azure-sdk-for-ruby - after_scripts: - - bundle install && rake arm:regen_all_profiles['azure_mgmt_web'] -``` - - - -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.web - package-name: azure-mgmt-web - package-version: 0.36.0 - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-web/azure/mgmt/web -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-web -``` - -## Python - -These settings apply only when `--python` is specified on the command line. - -``` yaml $(python) -python: - # override the default output folder - output-folder: $(output-folder)/python - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.web -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - - -## Java - -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.appservice -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appservice -directive: - from: WebApps.json - where: $.definitions.MSDeploy.properties.properties - transform: > - delete $.$ref; - $['allOf'] = [{'$ref':'#/definitions/MSDeployCore'}]; - return $; -``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-02 - - tag: package-2016-03-01-web - - tag: package-2016-08-01-web - - tag: package-2016-09-01-web -``` - -### Tag: package-2018-02 and java - -These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2018_02_01 - output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2018_02_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-03-01-web and java - -These settings apply only when `--tag=package-2016-03-01-web --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-03-01-web' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2016_03_01 - output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_03_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-08-01-web and java - -These settings apply only when `--tag=package-2016-08-01-web --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-08-01-web' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2016_08_01 - output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_08_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2016-09-01-web and java - -These settings apply only when `--tag=package-2016-09-01-web --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2016-09-01-web' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.appservice.v2016_09_01 - output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_09_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-03-01-hybrid - -These settings apply only when `--tag=package-2018-03-01-hybrid` is specified on the command line. -Creating this tag to pick proper resources from the hybrid profile for csharp code generation. - -``` yaml $(tag) == 'package-2018-03-01-hybrid' -input-file: -- Microsoft.Web/stable/2016-03-01/Certificates.json -- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json -- Microsoft.Web/stable/2016-08-01/WebApps.json -- Microsoft.Web/stable/2016-03-01/ResourceProvider.json -- Microsoft.Web/stable/2016-03-01/Provider.json -- Microsoft.Web/stable/2016-03-01/Recommendations.json -- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json -- Microsoft.Web/stable/2016-09-01/AppServicePlans.json +# Web + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Web. + + +The App service RP comprises of services where each service has its own tag. +Hence, each sub-service has its own swagger spec. + +All of them are tied together using this configuration and are packaged together into one compute client library. +This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. + + +--- +## Getting Started +To build the SDK for Web, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Web API. + +``` yaml +title: WebSiteManagementClient +description: WebSite Management Client +openapi-type: arm +tag: package-2018-11 +``` + +### Tag: package-2018-11 + +These settings apply only when `--tag=package-2018-11` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11' +input-file: +- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json +- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json +- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json +- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json +- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json +- Microsoft.Web/stable/2018-11-01/Certificates.json +- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json +- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json +- Microsoft.Web/stable/2018-02-01/Diagnostics.json +- Microsoft.Web/stable/2018-02-01/Provider.json +- Microsoft.Web/stable/2018-02-01/Recommendations.json +- Microsoft.Web/stable/2018-02-01/ResourceProvider.json +- Microsoft.Web/stable/2018-02-01/WebApps.json +- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json +- Microsoft.Web/stable/2018-02-01/AppServicePlans.json +- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json +directive: + # suppress each RPC 3019 error +- where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +``` + + +### Tag: package-2018-02 + +These settings apply only when `--tag=package-2018-02` is specified on the command line. + +``` yaml $(tag) == 'package-2018-02' +input-file: +- Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json +- Microsoft.CertificateRegistration/stable/2018-02-01/CertificateRegistrationProvider.json +- Microsoft.DomainRegistration/stable/2018-02-01/Domains.json +- Microsoft.DomainRegistration/stable/2018-02-01/TopLevelDomains.json +- Microsoft.DomainRegistration/stable/2018-02-01/DomainRegistrationProvider.json +- Microsoft.Web/stable/2018-02-01/Certificates.json +- Microsoft.Web/stable/2018-02-01/CommonDefinitions.json +- Microsoft.Web/stable/2018-02-01/DeletedWebApps.json +- Microsoft.Web/stable/2018-02-01/Diagnostics.json +- Microsoft.Web/stable/2018-02-01/Provider.json +- Microsoft.Web/stable/2018-02-01/Recommendations.json +- Microsoft.Web/stable/2018-02-01/ResourceProvider.json +- Microsoft.Web/stable/2018-02-01/WebApps.json +- Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json +- Microsoft.Web/stable/2018-02-01/AppServicePlans.json +- Microsoft.Web/stable/2018-02-01/ResourceHealthMetadata.json +directive: + # suppress each RPC 3019 error +- where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +``` + +### Tag: package-2016-09 + +These settings apply only when `--tag=package-2016-09` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09' +input-file: +- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json +- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json +- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json +- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json +- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json +- Microsoft.Web/stable/2016-03-01/Certificates.json +- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json +- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json +- Microsoft.Web/stable/2016-03-01/Diagnostics.json +- Microsoft.Web/stable/2016-03-01/Provider.json +- Microsoft.Web/stable/2016-03-01/Recommendations.json +- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json +- Microsoft.Web/stable/2016-03-01/ResourceProvider.json +- Microsoft.Web/stable/2016-08-01/WebApps.json +- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json +- Microsoft.Web/stable/2016-09-01/AppServicePlans.json +directive: + # suppress each RPC 3019 error +- where: $.definitions.User.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.SourceControl.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.BackupRequest.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.Deployment.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.Identifier.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.PremierAddOn.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.SiteExtensionInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.AppServicePlan.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.VnetRoute.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.FunctionEnvelope.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.CertificateOrderAction.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.ResourceMetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.TopLevelDomain.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.GeoRegion.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.PremierAddOnOffer.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.ContinuousWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.ProcessInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.ProcessThreadInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.SiteConfigurationSnapshotInfo.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.SiteInstance.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.SlotDifference.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.TriggeredJobRun.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.TriggeredWebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.WebJob.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.MetricDefinition.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.Usage.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +- where: $.definitions.AppServicePlanPatchResource.properties + suppress: R3019 + reason: It's an old API, will resolve in next API version + approved-by: "@ravbhatnagar" +``` + +### Tag: package-2015-08-preview + +These settings apply only when `--tag=package-2015-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08-preview' +input-file: +- Microsoft.Web/stable/2015-08-01/service.json +- Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json +``` + +### Tag: package-2015-08-certificate-registration + +These settings apply only when `--tag=package-2015-08-certificate-registration` is specified on the command line. + +``` yaml $(tag) == 'package-2015-08-certificate-registration' +input-file: +- Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json +- Microsoft.CertificateRegistration/stable/2015-08-01/CertificateRegistrationProvider.json +``` + +### Tag: package-2015-04-domain-registration + +These settings apply only when `--tag=package-2015-04-domain-registration` is specified on the command line. + +``` yaml $(tag) == 'package-2015-04-domain-registration' +input-file: +- Microsoft.DomainRegistration/stable/2015-04-01/Domains.json +- Microsoft.DomainRegistration/stable/2015-04-01/TopLevelDomains.json +- Microsoft.DomainRegistration/stable/2015-04-01/DomainRegistrationProvider.json +``` + +### Tag: package-2016-09-01-web + +These settings apply only when `--tag=package-2016-09-01-web` is specified on the command line. + +``` yaml $(tag) == 'package-2016-09-01-web' +input-file: +- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json +- Microsoft.Web/stable/2016-09-01/AppServicePlans.json +``` + +### Tag: package-2016-08-01-web + +These settings apply only when `--tag=package-2016-08-01-web` is specified on the command line. + +``` yaml $(tag) == 'package-2016-08-01-web' +input-file: +- Microsoft.Web/stable/2016-08-01/WebApps.json +``` + +### Tag: package-2016-03-01-web + +These settings apply only when `--tag=package-2016-03-01-web` is specified on the command line. + +``` yaml $(tag) == 'package-2016-03-01-web' +input-file: +- Microsoft.Web/stable/2016-03-01/Certificates.json +- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json +- Microsoft.Web/stable/2016-03-01/DeletedWebApps.json +- Microsoft.Web/stable/2016-03-01/Diagnostics.json +- Microsoft.Web/stable/2016-03-01/Provider.json +- Microsoft.Web/stable/2016-03-01/Recommendations.json +- Microsoft.Web/stable/2016-03-01/ResourceHealthMetadata.json +- Microsoft.Web/stable/2016-03-01/ResourceProvider.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_web'] +``` + + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.web + package-name: azure-mgmt-web + package-version: 0.36.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-web/azure/mgmt/web +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-web +``` + +## Python + +These settings apply only when `--python` is specified on the command line. + +``` yaml $(python) +python: + # override the default output folder + output-folder: $(output-folder)/python + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.web +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.appservice +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appservice +directive: + from: WebApps.json + where: $.definitions.MSDeploy.properties.properties + transform: > + delete $.$ref; + $['allOf'] = [{'$ref':'#/definitions/MSDeployCore'}]; + return $; +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-02 + - tag: package-2016-03-01-web + - tag: package-2016-08-01-web + - tag: package-2016-09-01-web +``` + +### Tag: package-2018-02 and java + +These settings apply only when `--tag=package-2018-02 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-02' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appservice.v2018_02_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2018_02_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-03-01-web and java + +These settings apply only when `--tag=package-2016-03-01-web --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-03-01-web' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appservice.v2016_03_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_03_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-08-01-web and java + +These settings apply only when `--tag=package-2016-08-01-web --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-08-01-web' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appservice.v2016_08_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2016-09-01-web and java + +These settings apply only when `--tag=package-2016-09-01-web --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2016-09-01-web' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appservice.v2016_09_01 + output-folder: $(azure-libraries-for-java-folder)/appservice/resource-manager/v2016_09_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-03-01-hybrid + +These settings apply only when `--tag=package-2018-03-01-hybrid` is specified on the command line. +Creating this tag to pick proper resources from the hybrid profile for csharp code generation. + +``` yaml $(tag) == 'package-2018-03-01-hybrid' +input-file: +- Microsoft.Web/stable/2016-03-01/Certificates.json +- Microsoft.Web/stable/2016-03-01/CommonDefinitions.json +- Microsoft.Web/stable/2016-08-01/WebApps.json +- Microsoft.Web/stable/2016-03-01/ResourceProvider.json +- Microsoft.Web/stable/2016-03-01/Provider.json +- Microsoft.Web/stable/2016-03-01/Recommendations.json +- Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json +- Microsoft.Web/stable/2016-09-01/AppServicePlans.json ``` \ No newline at end of file